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

Update README.md #668

Closed
wants to merge 4 commits into from
Closed

Update README.md #668

wants to merge 4 commits into from

Conversation

Jaime-jpg
Copy link

Improved readme file with an added section with steps for running the game locally using docker

Improved readme file with an added section with steps for running the game locally using docker
@0x5472616379
Copy link

My eyes, it's so bright 😭

I like the previous one, maybe just add the Docker part?
One of the deciding factors for me to actually try this project was also the fact that they added that nostalgic picture of the player in varrock.

@Jaime-jpg
Copy link
Author

woops, would adding the picture back make it better?
I found the readme pretty innaccessible personally.
Could also add the parabot joke back

README.md Outdated
@@ -1,42 +1,78 @@
# 2006Scape - an open source, actively developed emulation server. Pull requests welcome! ![Gameplay Image](https://i.imgur.com/WHnQz2W.png)
# 2006Scape Project

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

2006Scape Project - Pull requests are encouraged!

README.md Outdated

Welcome to the 2006Scape project! This repository contains both the server and client code, along with instructions to set up, build, and run the project for development purposes.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

README.md Outdated
3. **Running the Server:**
- Go to `2006Scape Server/src/main/java/com.rs2`.
- Right-click the `GameEngine` class and select **Run**.
- ![Run GameEngine](https://i.imgur.com/HHooeVu.png)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would prefer a dark theme so I don't burn my eyes out

README.md Outdated
4. **Running the Client:**
- Navigate to `2006Scape Client/src/main/java`.
- Right-click the `Client` class and select **Run**.
- ![Run Client](https://i.imgur.com/gSmqGLn.png)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would prefer a dark theme so I don't burn my eyes out

@Jaime-jpg
Copy link
Author

oh I didn't get the first time you were talking about the screenshots, those were there before my pull request, I just made them display in the readme instead of just having the link for them, I'll take new screenshots with dark theme

@Jaime-jpg
Copy link
Author

done!

@ipkpjersi
Copy link
Contributor

Looks like a nice improvement, good job.

@Jaime-jpg Jaime-jpg closed this Mar 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants