Skip to content

utilForever/omniring

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

38 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

A Rust library for building a reinforcement learning environment for Pokemon Champions

License: MIT Rust Typos Quality Gate Status Lines of Code Coverage
Maintainability Rating Reliability Rating Security Rating Bugs Vulnerabilities Technical Debt

What This Library Does

omniring provides the foundation for:

  • Modeling Pokemon Champions as an environment suitable for reinforcement learning agents.
  • Keeping simulation and game-state logic in a reusable Rust library crate.
  • Supporting future training, evaluation, and integration workflows around deterministic environment behavior.

Quick Start

Prerequisites

  • Rust stable toolchain with edition 2024 support
  • Git

1. Clone

git clone https://github.com/utilForever/omniring.git
cd omniring

2. Check the Library

cargo check --all
cargo test --all

Development

Run the same core checks used in CI for code changes:

cargo check --all
cargo fmt --all -- --check
cargo clippy --all-targets -- -D warnings
cargo test --all

Optional local parity with CI:

cargo install cargo-udeps
cargo +nightly udeps --all-targets

cargo install typos-cli
typos

License

Open Source Initiative approved license logo

This project is licensed under the MIT License:

Copyright © 2026 Chris Ohk and Hyeok Kwon.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

A reinforcement learning environment for Pokémon Champions

Resources

License

Stars

4 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages