Git Product home page Git Product logo

codex's Introduction

Codex

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 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

Adding New Games

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

  1. Open an issue 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 <Item/> 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.

codex's People

Contributors

mririgoyen avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.