Skip to content

Commit

Permalink
Simplify README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jidoc01 committed Jul 10, 2023
1 parent a7223c7 commit 0862c87
Showing 1 changed file with 3 additions and 65 deletions.
68 changes: 3 additions & 65 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ as we can.
|:--:|
| *In a room* |

| ![game](https://user-images.githubusercontent.com/12146267/183245667-5524b15f-648a-4d35-aaf6-b6dbb95eb018.png) |
|:--:|
| ![game](https://user-images.githubusercontent.com/12146267/183245667-5524b15f-648a-4d35-aaf6-b6dbb95eb018.png) |
|:--:|
| *In a game* |


Expand All @@ -63,69 +63,7 @@ as we can.

## How to run

### 0. Pre-requisite

#### For Server

+ Rust: [Cargo 1.62.0+](https://www.rust-lang.org/tools/install)
+ Git: [Git](https://git-scm.com/downloads)

#### For Client

+ Windows OS

### [Server] 1. Build the source code

First, you need to clone this respository:
`git clone https://github.com/jidoc01/RustyDO`

After cloning it, compile the source code:
`cargo build --release`

When it succeeds, it will generate an executable on `{root_directory}/target/release/server.*`. Copy the executable to some place and put `config.toml` to the same directory.

### [Server] 2. Run the server

To run the server, launch the `server.*`. It will open network port `9874` for both TCP and UDP. So, you should not use any of the same ports to prevent port collision. It is not modifiable unless you directly hack the client, and it is easily achievable but out-of-scope here.

### [Client] 1. Prepare the client program

First, download the client file `digimonbattleserver.rar` and uncompress it to some place. In its root directory, there are three sub-directories. You will use `Digimon Online` directory only.

And, you should edit configurations to launch the client program.

*NOTE*: You should not share the client with any modification. It is strictly forbidden in Korean copyright law. The archived client is as it was 2002 without modification.

#### [Client] 2-1. Edit the configuration

In the `Digimon Online` directory, there is `svr.info`, and open it with a text editor. Then, you can see ip addresses there. Replace them with your ip address. Let `SERVER_IP` be your ip address, then it'd look like:

```
101 0 100 SERVER_IP Status1
...
401 3 5000 SERVER_IP 폴더대륙
```

Note that the address should be a ***public*** ip address if it needs to be accessed via public network. And it should be a ***dot-separated*** address, not a domain name.

#### [Client] 2-2. Edit the registry

You need to write the absolute path of `Digimon Online` directory into the registry item `HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\X2Online\Digimon Online V1.5` with a key `PATH`.

For example, if your `Digimon Online` directory is `C:/X2Online/Digimon Online`, then you can use the following registry script:

```
Windows Registry Editor Version 5.00
[HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\X2Online\Digimon Online V1.5]
"PATH"="C:\\X2Online\\Digimon Online"
```

### [Client] 3. Launch the client executable

Now you can launch the client executable in `Digimon Online` directory. In the directory, the following instruction will launch the game: `digimon.dll "1 1"`.

FYI, you can write a batch script (*.bat) and launch it instead of typing the instruction every time you launch the game.
https://jidoc01.github.io/RustyDO


## To those who want to contribute
Expand Down

0 comments on commit 0862c87

Please sign in to comment.