f8eb18c202
Added modding functions and examples of room specific behavior in (clientMod and serverMod). Basic structures for NPC, semi-permanent objects, room-based soundtrack. Refactor sprite drawing - now called "things" and stored in and object |
5 years ago | |
|---|---|---|
| .. | ||
| lib | 5 years ago | |
| test | 5 years ago | |
| LICENSE | 5 years ago | |
| README.md | 5 years ago | |
| gulpfile.js | 5 years ago | |
| package.json | 5 years ago | |
| tonic.js | 5 years ago | |
README.md
RiTa: a generative language toolkit for JavaScript
The RiTa website
RiTa is designed to be an easy-to-use toolkit for experiments in natural language and generative literature. It is implemented in Java and JavaScript (with a common API for both). It is free/libre and open-source via the GPL license.
About the project
- Author: Daniel C. Howe
- License: GPL (see included LICENSE file for full license)
- Web Site: https://rednoise.org/rita
- Github Repo: https://github.com/dhowe/RiTaJS
- Issues: https://github.com/dhowe/RiTa/issues
- Reference: https://rednoise.org/rita/reference
- FAQ: https://github.com/dhowe/RiTa/wiki
- Related: RiTa (Java)
In node.js
To install, do the following from a terminal prompt
$ npm install rita
then use require() from your code
var rita = require('rita');
var rs = rita.RiString("The elephant took a bite!");
console.log(rs.features());
To run tests, do the following from a terminal prompt:
$ cd node_modules/rita && npm install && npm test
Or, see the 'Development Setup' instructions below...
Can I contribute?
Please! We are looking for more coders to help out... Just press Fork at the top of this github page and get started, or follow the instructions below...
Development Setup
-
Download and install git, npm, and gulp. If you have them already, move on to step #2.
a. You can find a version of git for your OS here
b. The easiest way to install npm is to install node.js
c. You can install gulp via npm as follows:$ npm install -g gulp -
Fork and clone this library.
a. First, login to github and fork the project
b. Then, from a terminal/shell:$ git clone https://github.com/dhowe/RiTaJS.git -
Now navigate into the project folder and install dependencies via npm.
$ cd RiTaJS && npm install -
To create the library from src, use gulp.
$ gulp build -
Optionally run tests in node with gulp.
$ gulp test -
Work on an existing issue, then submit a pull request...