https://github.com/mririgoyen/codex

A minimalistic, cross-platform item tracker for randomized games.
https://github.com/mririgoyen/codex

gaming item-tracker randomizer

Last synced: 18 days ago
JSON representation

A minimalistic, cross-platform item tracker for randomized games.

• Host: GitHub
• URL: https://github.com/mririgoyen/codex
• Owner: mririgoyen
• License: other
• Created: 2020-01-21T04:19:02.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-02-03T03:31:15.000Z (almost 2 years ago)
• Last Synced: 2024-10-14T08:48:38.712Z (about 1 month ago)
• Topics: gaming, item-tracker, randomizer
• Language: JavaScript
• Homepage:
• Size: 5.79 MB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 24
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        




  



# Codex

Codex is a minimalistic, cross-platform item tracker for randomized games. Built on React and Electron, it allows gamers on any operating system the ability to enjoy their favorite randomized games with ease.

# How to Install

Check the [releases tab](https://github.com/goyney/codex/releases) and download Codex for your operating system.

- **Windows**: The `exe` file will automatically install and launch Codex upon running it.

- **macOS**: Open the `dmg` file and drag Codex to your Applications folder.

- **Linux**: Make the `AppImage` file executable and run it.

# Supported Games

- [A Link to the Past Randomizer](https://alttpr.com/) (SNES)

# Adding New Games

There's a couple ways you can get a new game into Codex.

1. [Open an issue](https://github.com/goyney/codex/issues/new?labels=Game+Addition&template=1_game_addition.md&title=) requesting a game you'd like to see added.

2. Develop it yourself and open a PR.

## Developing New Game Trackers

To start developing, `yarn install` and then `yarn develop`.

Game tracker components are written in React, so an understanding of the React ecosystem is required to create new trackers. Game tracker components are located in the `src/renderer/components/Games` directory.

1. Create a new directory for a specific game (if one does not currently exist).

2. Develop your new item tracker component(s) for the game.

    - Any assets, such as custom `SCSS` files or `SVG` graphics specific to the game should be nested in the game directory.

3. Add a new entry in `src/renderer/components/Games/games.js` to register your item tracker(s).

There is a common `` component that can be used that should fit most use cases. Game-specific components should remain scoped to the game.

# License

MIT

Game trademarks and copyrights are properties of their respective owners.