Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a basic template for readme.md #27

Merged
merged 1 commit into from
Mar 18, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Prison Life Minigame Plugin

## Description
This Minecraft plugin replicates "Prison Life" game on Steam. Players join a server with 3-11 other players, each receiving a random role. The objective is simple: prisoners must work together to escape the prison within 4 days, while guards must prevent them from doing so.

## Features
- **Flexible Player Count**: Support for 3-11 players.
- **Role Assignment**: Players can be assigned roles such as prisoners or guards, each with their own objectives and gameplay mechanics.
- **Objective-based Gameplay**: Guards must prevent prisoners from escaping, while prisoners must work together to evade guards and break out of the prison.
- And more to come!

## Contributing
Contributions to the development of this plugin are welcome! If you encounter any bugs or have suggestions for new features, please open an issue or submit a pull request on GitHub.

## Credits
- **Plugin Developers**:
- [Tiago Farinha](https://github.com/TiagoFar78)
- [Raquel Braunschweig](https://github.com/iquelli)