跳转至

代码及本地运行

前置要求

如需使用代码,用户需要基本的编程能力。最低的要求是出于本地部署的需要,了解如何下载 Python 和运行 Python 程序(或者其它同等的搭建本地服务器的方式)。

注意

本地部署仍需访问网络使用第三方的库,并不能实现离线使用。

目前的代码是纯前端的,考虑兼容性,主要的代码都是基础的 HTML+CSS+JS。不需要在操作系统和浏览器中进行任何额外的配置。

另可阅读许可证一节。

本地运行

可选

有任何编程基础则可以跳过此部分。

提供下载是为了开源,不建议为了离线使用而下载源码运行——因为代码需要很多第三方js库,并不能离线使用(你也可以挨个将其下载到本地)。如需即刻使用,访问 itch.io 的链接更加方便。

在本地 Windows/Linux/Mac OS 部署有两种方式:

  • 搭建本地测试服务器(localhost)。此为常识,不再赘述。代码中附带了一个在index.html同文件夹路径下的简单 Python 程序 local server.py,运行后在浏览器端访问 http://localhost:8080/;也可以自行使用其它方式。
  • 安装 itch.io 的桌面应用(要求有 itch.io 的账号),是否可以做到离线使用?请参见指南,作者尚未尝试因此不知道。

本地部署可能会遇到以下几种问题:

  • 问:为什么直接打开 index.html 不能运行?答曰:浏览器的安全策略阻止跨域访问,故需搭建本地测试服务器。
  • 问:能否在平板和手机上部署?答曰:需要一定的技术基础,不建议这么做。
  • 问:有没有除了 Python 以外的方法?答曰:不知道。作者的编程能力退化很严重,此乃作者认知中最方便的做法。

其他问题

是否计划搭建为独立网站?

目前加了一堆字典和人名数据后仍然很轻量,没有这个必要。

人名生成部分是否能够作为单独的一个 package 使用?使用场景是什么?

代码还在修改之中,当前版本(v2.1.0)仍然没有将这一部分独立出来,因此也不能单独调用。在未来的版本中,如发布成单独的 package,你可以在严格遵守开源非商用不盈利的要求下(参照许可证),放置在个人设计的游戏和工具之中。如使用 Twine 等 HTML 游戏的开发工具,可以直接作为第三方 Javascript 接入。其它的开发软件或需进一步考虑 Javascript 的兼容性。

当然,目前并没有这样的功能。