Skip to content
This repository has been archived by the owner on Jul 3, 2019. It is now read-only.

AlexAegis/loreplotter

Repository files navigation

Build Status Codacy Badge Maintainability code style: prettier Greenkeeper badge

This project is a prototype tool for writers to ensure consistency in their work. It maps actor entities into a globe, and enforcing the laws of physics while doing so. Each one has a maximum possible speed which can be changed in an event of said actor. Based on this, the time difference between neighbouring events, their positions and the size of the planet, the application ensures that every actor, no matter what can reach from one event the next. It also tracks arbitrary properties in key-value pairs over time aswell. These are propagated down the timeline. If you inspect an actor at any given time you'll always see the latest values for every existing property of that actor. You can play back these scenarios to see these changes over-time. All the checks and constrainst work over-time, if you try to move an actor while playing you can essentially track that actors every possible position it could've possibly go over that period of time. The property handling is useful to evaluate what could happen when two actors meet, so you can see what each of them know, and figure out what would change.

Clicking on the title of the project or the link in the repositories description will take you to the application. It has a permament Example project for you to try out.

A hungarian documentation is also available under the releases section as a pdf.

Project usage

To install all required dependencies

npm install

To start a dev server

npm run start

To build the project

npm run build

To open the built project in a local http-server

npm run start:prod

Check bundle sizes

webpack-bundle-analyzer dist/loreplotter/stats-es2015.json

Technologies

Frontend framework

Package manager for JS projects

CSS extension

WebGL graphics

Animation easing

Reactive database interface

State management

Icons, awesome ones

Diagram tool. On windows, install with choco plantuml

Recommendations

IDE for mainly the frontend but can be used for both. Settings

Font with ligatures

Reload the Page for Chrome when the server changes

Services

Git repository

Static hosting

Continuous Integration solution

Code review tool

Code review tool for maintainability and coverage

Vulnerability detection

Badges to look cool