Skip to content

CrazyAZ/celer

 
 

Repository files navigation

celer

Celer is an engine for maintaining route documents for The Legend of Zelda: Breath of the Wild Speedruns

Packages

React web app for rendering routes. Currently the engine is written in typescript, but the plan is to migrate to rust to allow code sharing between web app and CLI

A command line util for route makers to initialize, bundle, and preview their routes locally (WIP)

celer-lib

Rust library for celer. It is used both in cli and the web app

Utility to generate code from csv files with game data (such as Koroks, Shrines, etc)

An extension for VS Code that adds syntax highlighting and auto completion for celer route files

Contributing

Need to install node 16, rust and python 3

Python modules:

  • toml
  • pyyaml
  • pylint
  • pylint-quotes

or run python3 -m pip install toml pyyaml pylint pylint-quotes

Rust crates:

  • just
  • wasm-pack

or run cargo install just wasm-pack

A linux/WSL environment is needed.

About

Celer Route Engine

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 63.9%
  • JavaScript 13.5%
  • Rust 12.6%
  • Python 8.8%
  • PowerShell 0.5%
  • HTML 0.3%
  • Other 0.4%