mirror of
https://github.com/ZGCA-Forge/Elevator.git
synced 2026-02-04 21:35:17 +00:00
Update ci
This commit is contained in:
84
README.md
Normal file
84
README.md
Normal file
@@ -0,0 +1,84 @@
|
||||
# Elevator Saga
|
||||
|
||||
<div align="center">
|
||||
|
||||
[](https://badge.fury.io/py/elevatorpy)
|
||||
[](https://pypi.org/project/elevatorpy/)
|
||||
[](https://github.com/ZGCA-Forge/Elevator/actions)
|
||||
[](https://zgca-forge.github.io/Elevator/)
|
||||
|
||||
[](https://github.com/ZGCA-Forge/Elevator)
|
||||
[](https://github.com/ZGCA-Forge/Elevator/fork)
|
||||
[](https://github.com/ZGCA-Forge/Elevator/issues)
|
||||
[](https://github.com/ZGCA-Forge/Elevator/blob/main/LICENSE)
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
Elevator Saga is a Python implementation of an elevator [simulation game](https://play.elevatorsaga.com/) with a event-driven architecture Design and optimize elevator control algorithms to efficiently transport passengers in buildings.
|
||||
|
||||
### Features
|
||||
|
||||
- 🏢 **Realistic Simulation**: Physics-based elevator movement with acceleration, deceleration, and realistic timing
|
||||
|
||||
## Installation
|
||||
|
||||
### Basic Installation
|
||||
|
||||
```bash
|
||||
pip install elevatorpy
|
||||
```
|
||||
|
||||
### With Development Dependencies
|
||||
|
||||
```bash
|
||||
pip install elevatorpy[dev]
|
||||
```
|
||||
|
||||
### From Source
|
||||
|
||||
```bash
|
||||
git clone https://github.com/ZGCA-Forge/Elevator.git
|
||||
cd Elevator
|
||||
pip install -e .[dev]
|
||||
```
|
||||
|
||||
## Quick Start
|
||||
|
||||
### Running the Game
|
||||
|
||||
```bash
|
||||
# Start the backend simulator (Terminal #1)
|
||||
python -m elevator_saga.server.simulator
|
||||
```
|
||||
|
||||
```bash
|
||||
# Start your own client (Terminal #2)
|
||||
# Example:
|
||||
python -m elevator_saga.client_examples.bus_example
|
||||
```
|
||||
|
||||
## Documentation
|
||||
|
||||
For detailed documentation, please visit: [https://zgca-forge.github.io/Elevator/](https://zgca-forge.github.io/Elevator/)
|
||||
|
||||
## Contributing
|
||||
|
||||
Contributions are welcome! Please feel free to submit a Pull Request.
|
||||
|
||||
## Star History
|
||||
|
||||
[](https://star-history.com/#ZGCA-Forge/Elevator&Date)
|
||||
|
||||
## License
|
||||
|
||||
This project is licensed under MIT License - see the [LICENSE](LICENSE) file for details.
|
||||
|
||||
---
|
||||
|
||||
<div align="center">
|
||||
|
||||
Made with ❤️ by the ZGCA-Forge Team
|
||||
|
||||
</div>
|
||||
Reference in New Issue
Block a user