raven-shield-2020/CUSTOM.md

53 lines
3.4 KiB
Markdown
Raw Normal View History

2020-05-12 06:54:19 +02:00
# Mods and Custom Content
2020-05-11 01:57:27 +02:00
## Installing Custom Content
2020-05-11 02:09:26 +02:00
### Maps
2020-05-13 04:53:21 +02:00
Two large sources of custom maps are [rvs.go2.rip](https://rvs.go2.rip/maps) and [woody2000.com](http://www.woody2000.com/download.php?list.2).
2020-05-11 02:09:26 +02:00
Custom maps will often come as a `.exe` file which extracts its contents when you run it. You can point these at your game directory to have it put files in the right places. If you have security concerns about running such a program, you can alternatively run the program inside a Windows XP VM and then take out the resulting files.
If the map is already extracted, it will generally have a series of folders to be copied into your game directory: `maps` for the map itself, `system` for the map config, `staticmeshes` and `textures` for some maps, etc. Copy the contents of these folders into their corresponding game folders to install the content.
2020-05-11 02:16:31 +02:00
When playing on servers which allow you to download custom content, these files will be placed in the `<YourGameDir>\Cache` directory. See `Cache.ini` to identify which file is which.
2020-05-11 02:09:26 +02:00
2020-05-11 02:05:18 +02:00
### Sounds
2020-05-13 04:53:55 +02:00
There are prebuilt sound packs such as the [AllR6 Sound Pack](http://allr6.com/discuss/viewtopic.php?id=68&i=1), which includes Athena Sword and Iron Wrath sounds.
2020-05-11 02:05:18 +02:00
2020-05-11 03:13:06 +02:00
## Clearing the Content Cache
2020-05-19 02:52:12 +02:00
Cached content is automatically deleted after 30 days (configurable in `RavenShield.ini`).
2020-05-19 02:52:35 +02:00
If you want to manually clear the cache, open `<YourGameDir>\Cache` and delete its contents. `Cache.ini` will be automatically recreated by the game.
2020-05-11 03:13:06 +02:00
2020-05-12 06:55:09 +02:00
## Running Servers with Custom Content
2020-05-11 02:17:33 +02:00
2020-05-12 06:55:30 +02:00
#### Disk Space Requirements
2020-05-11 02:27:21 +02:00
2020-05-14 19:39:45 +02:00
A basic Linux Droplet (see [SERVERS.md](SERVERS.md)) will give you 25GB of storage, which may not be enough to host your custom content. If that's the case, you'll need to upgrade to a larger Droplet type.
2020-05-11 02:27:21 +02:00
2020-05-12 06:55:30 +02:00
#### Download Speeds
2020-05-11 02:27:21 +02:00
You may find in testing that download speeds for custom content are much slower than expected. When using a VPS to host game servers, one can expect download speeds of roughly 20KB/s. A basic web host or file server can generally transfer at speeds up to 100Mb/s in short bursts. In order to offload this activity to a faster server/network, we can use Raven Shield's built-in download redirection:
1. Configure an HTTP server (such as Nginx, or a paid web hosting service) which can serve files.
2020-05-11 02:33:01 +02:00
1. Place custom content on the file server in the same directory structure as the game: maps in `/maps/`, textures in `/textures/`, etc.
1. On your game server, edit `RavenShield.ini` and look for the `RedirectToURL` option. Set this to the URL of your file server, e.g. `http://www.myserver.net/`.
1. Restart your game server to pick up the new config.
2020-05-11 02:27:21 +02:00
2020-05-12 03:05:59 +02:00
When users connect to your game server, they will be instructed to download all custom content from the file server, resulting in significantly faster downloads. If the client fails to retrieve the file from the file server for any reason, it will fall back to downloading the file from the game server, resulting in slow speeds. If this happens, the player can cancel and rejoin the server to restart the download from the file server.
2020-05-13 04:09:57 +02:00
## Creating Custom Content
2020-05-13 04:54:39 +02:00
### Creating Maps
2020-05-13 04:09:57 +02:00
2020-05-13 05:15:16 +02:00
The map editor, `UnrealEd`, can be found on your hard drive at `<YourGameDir>\system\UnrealEd.exe`.
See the [RvSMaps.com guide](http://rvsmaps.smclan.org/tut_sounds.htm) for more info.
2020-05-13 04:53:21 +02:00
2020-05-13 04:54:39 +02:00
### Creating Mods
See [Twi's Raven Shield SDK on ModDB](https://www.moddb.com/mods/raven-shield-software-development-kit). This includes a copy of the game's source code (version 1.56).