SoulsGym
Gymnasium extension for DarkSouls III, Elden Ring, and other Souls games
File Explorer
Download Latest Version (.zip)- github-actions.yaml
- DS3_TGA.CT
- ER_TGA.CT
- game_input.rst
- game_memory.rst
- game_window.rst
- index.rst
- speedhack.rst
- static.rst
- utils.rst
- game_state.rst
- index.rst
- iudex.rst
- soulsenv.rst
- vordt.rst
- darksouls3.rst
- eldenring.rst
- game.rst
- index.rst
- gym.rst
- setup.rst
- logo.png
- soulsgym_banner.png
- acknowledgements.rst
- stability.rst
- conf.py
- exception.rst
- index.rst
- make.bat
- Makefile
- requirements.txt
- soulsgym.rst
- run_envs.py
- actions.yaml
- addresses.yaml
- animations.yaml
- bonfires.yaml
- coordinates.yaml
- keys.yaml
- player_stats.yaml
- actions.yaml
- addresses.yaml
- animations.yaml
- bonfires.yaml
- coordinates.yaml
- keys.yaml
- player_stats.yaml
- speedhack.dll
- lib.rs
- build.rs
- Cargo.lock
- Cargo.toml
- exports.def
- README.md
- __init__.py
- speedhack.py
- __init__.py
- game_input.py
- game_memory.py
- game_window.py
- platform.py
- static.py
- utils.py
- __init__.py
- iudex.py
- vordt.py
- __init__.py
- game_state.py
- soulsenv.py
- utils.py
- __init__.py
- darksouls3.py
- eldenring.py
- game.py
- __init__.py
- exception.py
- __init__.py
- test_envs.py
- __init__.py
- test_game.py
- __init__.py
- __init__.py
- test_game.py
- __init__.py
- pytest.ini
- test.py
- utils.py
- .gitignore
- .readthedocs.yaml
- LICENSE
- pyproject.toml
- README.md
- requirements.txt
- uv.lock
# Installation Guide
1. Get the code
git clone https://github.com/amacati/SoulsGym
Downloads the entire project code from GitHub to your computer.
cd SoulsGym
Moves into the project folder you just downloaded.
2. Python
Easy RecommendedPrerequisites
pip install -r requirements.txt
Installs the Python libraries listed in requirements.txt (or similar).
python <μ€νν νμΌλͺ
>.py # READMEμμ μ νν μ€ν νμΌλͺ
μ νμΈνμΈμ
Runs the Python script (or module).
If it runs without errors and prints output in the terminal, it worked.
3. Rust
MediumPrerequisites
- Git Needed to download the project code from GitHub.
- Rust (rustup) Installing via rustup also installs cargo.
β οΈ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd soulsgym/core/speedhack/rust
This project's files live in a subfolder, so move into it first.
cargo build --release
Compiles the Rust project.
cargo run
Builds and then immediately runs the program.
If cargo build finishes without errors, it worked. The executable is created under target/.
// repository documentation
Was this content helpful?
(0 ratings)