by Chris Klimas, Leon Arnott, Daithi O Crualaoich, Ingrid Cheung, Thomas Michael Edwards, Micah Fitch, Juhana Leinonen, Michael Savich, and Ross Smith
This is a port of Twine to a local browser-based app. See twinery.org for more info.
The story formats in minified format under
story-formats/ exist in separate
A NOTE ABOUT YARN
Any time you read
npm below, you can also use
yarn is a little more foolproof, as
it ensures that everyone is using the exact same version of dependencies.
npm install at the top level of the directory to install all goodies.
npm start to begin serving a development version of Twine to
http://localhost:8080. This server will automatically update with changes you
make. You can also create a dev build at
npm run build.
npm run lint and
npm test will lint and test the source code respectively.
npm run pot will create a POT template file for localization at
src/locale/po/template.pot. See Localization below for more information.
To build distributable versions of Twine, use
npm run package. This will
create ZIP archives and Windows installer packages under
additional file named
2.json is created under
dist/. This contains
information relevant to the autoupdater process, and is currently posted to
npm run clean will delete existing files in
Download template.pot from the repository.
Use a translation application like Poedit to create a .po file with the source text translated. If you are using Poedit, get started by choosing New from POT/PO File from the File menu. Make sure to name your po file according to the IETF locale naming convention -- Poedit can help suggest that as well. For example, a generic French translation should be named
fr.po, while an Australian English one would be named
Finally, two other things are needed: an SVG-formatted image of the flag that should be associated with your language, and what native speakers call the language you are localizing to (e.g. Français for French speakers). Wikimedia Commons is your best bet for nice-looking SVG flags. Obviously, whatever image you provide must either be in the public domain or otherwise OK to use in Twine without any compensation.
If you're comfortable using Mercurial, then you can open a pull request to have your localization added. Please place it in the
src/locale/podirectory. If you aren't, you can instead open a bug tracker issue and attach your PO file, flag image, and language name and we'll take it from there.