Update README.md

README.md

@@ -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
 
+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.
 ## Discord Link: https://discord.gg/hZ6VfWG
+## Resources
 
-## How to Play
+- **Client/Launcher Download:** [2006Scape.org](https://2006Scape.org/)
+- **Rune-Server Project Thread:** [Project Thread](https://www.rune-server.ee/runescape-development/rs2-server/projects/686444-2006rebotted-remake-server-will-allow-supply-creatable-bots.html)
 
-### Client/Launcher Download: https://2006Scape.org/
-### Rune-Server project thread: [Project thread](https://www.rune-server.ee/runescape-development/rs2-server/projects/686444-2006rebotted-remake-server-will-allow-supply-creatable-bots.html)
+## Prerequisites
 
-# Installation + Running (Developers)
+Before getting started, ensure you have the following installed:
 
-1. Import Project in IntelliJ
+- **Java 8:** [Download Java 8 SDK](https://adoptopenjdk.net/?variant=openjdk8)
+- **IntelliJ IDEA:** Recommended for development.
+- **Maven:** For command-line builds.
+- **Docker (Optional):** To run the client locally using Docker Compose. [Get Docker](https://docs.docker.com/get-started/get-docker/)
 
-2. Hit File > Project Settings > Set SDK to Java 8 (Download [Java 8 SDK](https://adoptopenjdk.net/?variant=openjdk8) if you don't have one already)
+## Installation & Running (Developers)
 
-3. Navigate to `2006Scape Server` > `src` > `main` > `java` > `com.rs2`, right click GameEngine and hit Run [Image](https://i.imgur.com/HHooeVu.png)
+### Setting Up the Project in IntelliJ
 
-   [(You Can Also Run The Server With The -c/-config Argument)](https://wiki.2006scape.org/books/getting-setup/page/server-arguments)
-5. Navigate to `2006Scape Client` > `src` > `main` > `java`, right click Client and hit Run [Image](https://i.imgur.com/gSmqGLn.png)
+1. **Import the Project:**
+   - Open IntelliJ IDEA and import the project from the repository.
 
-*Advanced*
+2. **Configure the SDK:**
+   - Navigate to **File > Project Structure** (or **Project Settings**) and set the SDK to Java 8.
 
-To compile any module from the command line, run `mvn clean install`
+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)
+   - *Alternative:* Run the server with the `-c` or `-config` argument. See details on the [Server Arguments Wiki](https://wiki.2006scape.org/books/getting-setup/page/server-arguments).
 
-## Using Parabot with your local server:
-- **1:** Download the latest Parabot Client from [here](https://github.com/2006-Scape/Parabot/releases)
-- **2:** Run the parabot client with the following arg:
-```fix
-java -jar Parabot.jar -local
-```
-- **3:** ???
-- **4:** PROFIT
+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)
 
-### Server source layout
+### Building from the Command Line
 
-- `2006Scape Server` contains all the server code; mark `src` as the Sources directory
-- `2006Scape Client` contains all the client code; likewise mark `src`
-  - If more than 2 arguments are passed in (can be anything), the client runs locally
+- **Compile a Module:**
+  ```bash
+  mvn clean install
 
-## Building from command line
+- **Build the Entire Project:**
+   ```bash
+   mvn -B clean install
+
+## Advanced Topics
+### Using Parabot with Your Local Server
+1. **Download the Latest Parabot Client:**
 
-Run `mvn -B clean install`
+2. **Launch Parabot:**
+
+   - Run the following command:
+   ```bash
+   java -jar Parabot.jar -local
+
+3. **Follow On-Screen Instructions:**
+   - Complete any additional steps as prompted by the Parabot client.
+### Server Source Layout
+- **2006Scape Server:** Contains all server code. Mark the src folder as the sources directory.
+- **2006Scape Client:** Contains all client code. Similarly, mark the src folder as the sources directory.
+   - Note: When more than two arguments (any values) are passed in, the client runs in local mode.
+### Playing Locally with Docker Compose
+1. **Start Docker Compose:**
+   Run:
+   ```bash
+   docker compose up -d
+   ```
+   *(Make sure Docker is installed and configured.)*
+2. **Run the Client:**
+   Execute:
+   ```bash
+   java -jar "2006Scape Client/target/client-1.0-jar-with-dependencies.jar"
+   ```
+   *(Replace / with \ on Windows.)*