Skip to content

Commit

Permalink
Beautify README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Metadorius committed Oct 29, 2020
1 parent b97dcdd commit 9383b4b
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
CnCNet for Ares
================================================================================

Spawns Yuri's Revenge and connects players through cncnet5. This project should be used in conjunction with the [xna-cncnet-client](https://github.com/CnCNet/xna-cncnet-client) and [Ares](https://launchpad.net/ares/+download)
Provides an ability for Yuri's Revenge with Ares to use CnCNet5 to play online. This project should be used in conjunction with the [XNA CnCNet Client](https://github.com/CnCNet/xna-cncnet-client) and [Ares](https://launchpad.net/ares/+download).

## Usage
- Place cncnet5.dll in you mod folder with the xna-cncncet-client and the Ares files.
- Optionally place rename.dll in the mod directory.
- Syringe from Ares will automatically detect and include cncnet5.dll.
- Configure xna-cncnet-client to execute Syringe.exe rather than game(md).exe
- Place `cncnet5.dll `in you mod folder with the XNA CnCNet Client and Ares files.
- Optionally place `rename.dll` in the mod directory.
- Syringe (included with Ares) will automatically detect and include `cncnet5.dll`.
- Configure xna-cncnet-client to execute `Syringe.exe` rather than `gamemd.exe`.

## Building
- Download cncnet-for-ares
- Edit src/rename.c, change the strings for the Gane name and file locations. Do not exceed the size of the existing strings in the game.
- Download [win-builds](https://downloads.cncnet.org/win-builds-for-patching.zip) and install it by double clicking win-install.bat
- In the cncnet5-for-ares run build.cmd by double clicking on it. Read the output window any errors you may have introduced.
- You should now have rename.dll. Now you can rename rename.dll to something appropriate for your mod (the name will not stop it from being loaded by Syringe).
- Download or clone `cncnet-for-ares` repository.
- Edit `src/rename.c`, change the strings for the Gane name and file locations. Do not exceed the size of the existing strings in the game.
- Download [win-builds](https://downloads.cncnet.org/win-builds-for-patching.zip) and install it by double clicking `win-install.bat`.
- In the `cncnet-for-ares` run `build.cmd` by double clicking on it. Read the output window any errors you may have introduced.
- You should now have `rename.dll`. Now you can rename it to something appropriate for your mod (the name will not stop it from being loaded by Syringe).

## Caveats
- Source code for cncnet5.dll is not public, only the cncnet5.dll file is provided here.
- You do not need to use the command line -SPAWN argument.
- You may need to edit build.cmd if win-builds did not get installed into C:\win-builds-patch-32\
- Source code for `cncnet5.dll` is not public, only the `cncnet5.dll` file is provided here.
- You do not need to use the command line `-SPAWN` argument.
- You may need to edit `build.cmd` if win-builds did not get installed into `C:\win-builds-patch-32\`.

0 comments on commit 9383b4b

Please sign in to comment.