Skip to content
Snippets Groups Projects
Commit 593f63c1 authored by Florian Schröder's avatar Florian Schröder
Browse files

Update .gitlab-ci.yml and expand CHANGELOG.md

Updated the pdoc command in .gitlab-ci.yml file to correct the hyphen usage in the "footer_text" flag. The CHANGELOG.md is significantly expanded to provide a more detailed and organized account of changes with version releases, following the guidelines from keepachangelog.com.
parent 09a0bc5c
No related branches found
No related tags found
No related merge requests found
Pipeline #47811 failed
......@@ -18,7 +18,7 @@ pages:
- apt-get install -y python3-dev python3-pip graphviz graphviz-dev
- pip install pdoc
- pip install ".[rl]"
- pdoc --output-dir public cooperative_cuisine !cooperative_cuisine.reinforcement_learning --logo https://gitlab.ub.uni-bielefeld.de/uploads/-/system/project/avatar/6780/Cooking-Vector-Illustration-Icon-Graphics-4267218-1-580x435.jpg --docformat google --favicon overcooked-simulator/cooperative_cuisine/pygame_2d_vis/images/favicon.ico footer_text "Developed@[SCS](https://scs.techfak.uni-bielefeld.de/)"
- pdoc --output-dir public cooperative_cuisine !cooperative_cuisine.reinforcement_learning --logo https://gitlab.ub.uni-bielefeld.de/uploads/-/system/project/avatar/6780/Cooking-Vector-Illustration-Icon-Graphics-4267218-1-580x435.jpg --docformat google --favicon overcooked-simulator/cooperative_cuisine/pygame_2d_vis/images/favicon.ico footer-text "Developed@[SCS](https://scs.techfak.uni-bielefeld.de/)"
artifacts:
paths:
- public
......
# Release Notes
[How to keep the changelog](https://keepachangelog.com/en/1.1.0/):
- `Added` for new features.
- `Changed` for changes in existing functionality.
- `Deprecated` for soon-to-be removed features.
- `Removed` for now removed features.
- `Fixed` for any bug fixes.
- `Security` in case of vulnerabilities.
## [Unreleased]
### Added
### Changed
### Deprecated
### Removed
### Fixed
### Security
## [1.0.0] (2024-03-XX)
Release of v1. Now change the development process to an incremental updates, use of the changelog and semantic
versioning.
_Cooperative Cuisine_ **v1** is feature complete. It contains a usable _Overcooked!_-like environment, game server,
study server, 2D visualization, etc.
### Added
- continuous-like movement and pushing other players around
- extending recording, scoring, msgs via hooks at different programm points
- implemented random-action agent
- players connect via websockets
- 2D visualization with pygame
- Everything is configurable with config files: item info (ingredients, meals, etc.), layout, environment,
visualization, study
- Game server that handles active environments
- Study environment with study server and study config. Does the match making
- Controller support
### Security
- To manage environments on the game server, the "manager" needs to have a valid `manager_id` which is registered in the
game server.
- Registered players (humans and agents) need to connect to a websockets that are preregistered with a `client_id`.
- Each player actions need to be references with a `player_hash` that should only be known by the player / client that
controls the player.
## 0.1.0 (2023-11-23)
- Created
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment