Skip to content

theAwesomeFufuman/Tracitor

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

51 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Tracitor - a Tracery editor

What is this?

An editor for Tracery, made with a simple UI.

Installation

You can use this application by doing one of the following:

  • Visit the web version of the project
  • Download the repository and open index.html

Usage

JSON editor

The JSON editor works the same way as Tracery does. Fill in your Tracery grammar JSON object and click on '📖 Generate story'. The start symbol for the Tracery grammar is always 'origin', so make sure that you have a symbol called 'origin' that refers to the rest of your symbols for the application to work. The button titled '📋 Copy JSON to the clipboard' copies the JSON object to the clipboard for use and/or storage outside of this application.

Simple editor

The simple editor works in a similar way to the JSON editor. You create a symbol by giving it a title in the first field and a rules in the second field(separated by commas). To add another symbol, click the button titled '✔️ Add another symbol'. Once your symbols are all set up, you can put it all together in the big textarea below the symbol input fields by refering to the symbols by their name(s) surrounded with '#'s, e.g. #animal# for a symbol with the title 'animal'. Finally you click '📖 Generate story' to see the result. The button titled '📋 Copy JSON to the clipboard' copies the template for your current story to the clipboard for use and/or storage outside of this application. To import a saved story, paste the information in the JSON editor and click on '📖 Generate story'.

View generated story

Here you will see the result of the generated story that you have created. Click on '📋 Copy the story to the clipboard' to copy the story in the textarea. Click on '📖 Reroll story' to generate a new random story from the symbols that you have created in either the JSON editor or in the Simple Editor.

For a more extensive explanation on how to use Tracery within this editor, either visit the Tracery Github page or this Tracery turorial.

Contact

You can reach me at tracitor[dot]contact[at]gmail[dot]com

Acknowledgments

I would like to thank the authors of the following technologies. Without them, this small project would not be possible.

Background image

Wikimedia Commons

License

MIT License

Copyright (c) 2020 theAwesomeFufuman

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.