README.md

Totum

Map Keyboard Configuration

• Arrow Right - Progress the map forward by one.
• Arrow Left - Undo the progress by one.
• CTRL + SHIFT + Arrow Right - Progress the map forward by a full branch.
• CTRL + SHIFT + Arrow Left - Undo the progress by a full branch.

Table of Contents

• Features
• Installation
• Contributing
• License

Features

Totum allows users to:

• View different game maps (sky, surface, cave, depths) with points and branches plotted on them.
• Interact with these points and branches.
• Create, move, and delete points and branches.
• View and edit notes associated with selected points and branches.
• Display upcoming points on the route.
• Display the progress of certain in-game actions.
• Save and load routes, including their points, branches, and associated notes.

Installation

Clone the repository:

git clone https://github.com/totum-tools/totum-routing.git
cd totum

Install the dependencies:

npm install

Start the development server:

npm start

Contributing

Contributions are welcome. Just make PRs.

We use GitHub issues to track bugs and enhancements. If you find a bug or have an idea for an improvement, please submit an issue.

License

Totum is released under the GNU GPLv3 License. See the LICENSE file for more details.