Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
selimnahimi authored Sep 1, 2023
1 parent 62fc913 commit e511036
Showing 1 changed file with 5 additions and 9 deletions.
14 changes: 5 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,18 @@
## What is this?
This is a fan remake of the [Mirror's Edge](https://store.steampowered.com/app/17410/Mirrors_Edge/) parkour system in [S&box](https://sbox.facepunch.com), in the form of a custom gamemode.

*! Keep in mind that this is currently heavily in development. !*

## What's included?
- A close from-scratch remake of the Mirror's Edge movement
- Custom UI resembling the style of the original game

## Are you planning to port the entire game?
No, this is just a remake of the movement system.

## How do I run this?
*! Keep in mind that this is currently heavily in development. Please only consider playing this once a release is added to the repository. !*

Clone the `dev-preview` branch, and import it as a game inside the S&box devtool GUI.

## Roadmap
Check out the [GitHub Project](https://github.com/users/selimnahimi/projects/3/views/1) for a detailed view of current development.

## Contributing
Currently there is no defined method of contribution, but issues/pull requests are welcome.

Please keep in mind that this gamemode is heavily in development, and will have a lot of issues that are in the process of being fixed. Expect daily updates.
Clone the `dev-preview` branch, and import it as a game inside the S&box devtool GUI.

Please keep in mind that this project is under heavy development, and will have a lot of issues that are in the process of being fixed. Expect daily updates.

0 comments on commit e511036

Please sign in to comment.