-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
53 additions
and
58 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,77 +1,72 @@ | ||
| # SourceCoop | ||
|
|
||
| [](https://github.com/ampreeT/SourceCoop/actions/workflows/plugin.yml) | ||
| [](https://github.com/ampreeT/SourceCoop/releases/latest) | ||
| [](https://discord.gg/Fh77rxQaEB) | ||
|
|
||
| | [Installation Guide](#installation-guide) - [Campaign Support](#campaign-support) - [Contributing](#contributing) - [Credits](#credits) | ||
| :--: | | ||
| | [Features & Configuration](https://github.com/ampreeT/SourceCoop/wiki/Features-&-Configuration) - [Server Running Tips](https://github.com/ampreeT/SourceCoop/wiki/Server-running-tips) - [Public Servers](https://github.com/ampreeT/SourceCoop/wiki/Public-Servers) | | ||
| | [Developing](https://github.com/ampreeT/SourceCoop/wiki/Developing) - [EDT Map Script Format](https://github.com/ampreeT/SourceCoop/wiki/EDT---Map-script-format) - [Authoring Maps](https://github.com/ampreeT/SourceCoop/wiki/Authoring-maps-for-SourceCoop) | | ||
|
|
||
| SourceCoop is a cooperative mod for Source Engine games enabling singleplayer campaigns to be played together. It currently supports [Black Mesa](https://store.steampowered.com/app/362890/Black_Mesa/) and [Half-Life 2: Deathmatch](https://store.steampowered.com/app/320/HalfLife_2_Deathmatch/). | ||
| # SourceCoop | ||
|
|
||
| - Supports campaigns. | ||
| - Restores singleplayer functionality. | ||
| - Handles player and equipment persistence between maps. | ||
| - Easy to use optional addons. | ||
| - Easy for mappers to convert new and existing maps from singleplayer into cooperative. | ||
| SourceCoop is a cooperative mod for multi-player Source Engine games, that | ||
| - Enables players to play together on single-player campaigns or maps | ||
| - Complements existing cooperative campaigns or maps | ||
| - Fixes various crashes | ||
| - Re-enables single-player functionality | ||
| - Includes map configs adjusting for cooperative play | ||
| - Comes with optional addons, enhancing your experience | ||
| - Can be used by server owners as the ultimate map config tool | ||
| - Is built on [SourceMod](https://www.sourcemod.net) | ||
| - __Only needs to be installed on the server__. | ||
|
|
||
| ## Installation Guide | ||
| __If you are someone who is looking to play on a server__, you are already completely set up and ready to play! Cooperative servers can be found on the server browser just like any other server. | ||
|
|
||
| __If you are someone who is looking to play on a server__, then you are already set up and ready to play! Cooperative servers can be found in the server browser just like any other server. | ||
|
|
||
| __If you are a server operator who is looking to host your own cooperative server__, then follow the instructions below: | ||
|
|
||
| - Install [Metamod:Source](https://www.sourcemm.net/downloads.php?branch=stable) (latest tested build ➤ __1148__) | ||
| - Install [SourceMod](https://www.sourcemod.net/downloads.php?branch=stable) (latest tested build ➤ __6960__) | ||
| - Install [the latest release of SourceCoop](https://github.com/ampreeT/SourceCoop/releases). | ||
| __If you are a server operator who is looking to host your own cooperative server__, then follow the instructions below. | ||
| - Install [Metamod:Source](https://www.sourcemm.net/downloads.php?branch=stable) | ||
| - Latest tested build ➤ __1148__ | ||
| - Install [SourceMod](https://www.sourcemod.net/downloads.php?branch=stable) | ||
| - Latest tested build ➤ __6960__ | ||
| - Install the latest release of SourceCoop from the [releases page](https://github.com/ampreeT/SourceCoop/releases). | ||
|
|
||
| A step-by-step guide for Black Mesa is also available on [Steam](https://steamcommunity.com/sharedfiles/filedetails/?id=2200247356). | ||
|
|
||
| ## Campaign Support | ||
|
|
||
| ### Black Mesa | ||
|
|
||
| - [Main Campaign](https://store.steampowered.com/app/362890/Black_Mesa/) | ||
| - [Stojkeholm](https://steamcommunity.com/sharedfiles/filedetails/?id=2320533262) | ||
| - [Emergency 17](https://steamcommunity.com/sharedfiles/filedetails/?id=934371395) | ||
|
|
||
| ### Custom Configurations | ||
|
|
||
| SourceCoop is __designed to support configurations of singleplayer maps__ without going through the process of decompiling and redistributing map files. Configurations can be created for maps that SourceCoop already does not handle. __If you are interested in creating your own configuration__, read more on [EDT Map Script Format](https://github.com/ampreeT/SourceCoop/wiki/EDT---Map-script-format). | ||
| ## Additional information | ||
| - [Features & Configuration](https://github.com/ampreeT/SourceCoop/wiki/Features-&-Configuration) | ||
| - [Server running tips](https://github.com/ampreeT/SourceCoop/wiki/Server-running-tips) | ||
| - [Authoring maps for SourceCoop](https://github.com/ampreeT/SourceCoop/wiki/Authoring-maps-for-SourceCoop) | ||
| - [EDT Map script format](https://github.com/ampreeT/SourceCoop/wiki/EDT---Map-script-format) | ||
| - [Developing](https://github.com/ampreeT/SourceCoop/wiki/Developing) | ||
| - [Public Servers](https://github.com/ampreeT/SourceCoop/wiki/Public-Servers) | ||
|
|
||
| ## Contributing | ||
|
|
||
| __If you are looking to help with the development of the project__, we are always looking for more help! Heres some ways you can help: | ||
|
|
||
| - Debugging and tracking down issues | ||
| - Adding features | ||
| - Adding new configurations for campaigns and maps | ||
|
|
||
| __If you are interested in helping us__, contact us on [Discord](https://discord.gg/Fh77rxQaEB) or create a pull request. | ||
| - Adding configs for new campaigns or levels | ||
|
|
||
| If you are interested in helping us, contact us on [Discord](https://discord.gg/Fh77rxQaEB) or create a pull request. | ||
|
|
||
| ## Credits | ||
|
|
||
| ### Contributors | ||
|
|
||
| - __ampreeT__ :: [Steam](https://steamcommunity.com/id/ampreeT) | [GitHub](https://github.com/ampreeT) :: programming, reverse engineering, map editing | ||
| - __kasull__ :: [Steam](https://steamcommunity.com/id/kasull/) | [GitHub](https://github.com/kasullian) :: programming, reverse engineering, trailer production | ||
| - __Alienmario__ :: [Steam](https://steamcommunity.com/id/4oM0/) | [GitHub](https://github.com/Alienmario) :: programming, reverse engineering, map editing | ||
| - __Balimbanana__ :: [Steam](https://steamcommunity.com/id/Balimbanana/) | [GitHub](https://github.com/Balimbanana) :: programming, reverse engineering | ||
| - __Rock__ :: [Steam](https://steamcommunity.com/id/Rock48/) | [GitHub](https://github.com/Rock48) :: programming, map editing | ||
| - __Krozis Kane__ :: [Steam](https://steamcommunity.com/id/Krozis_Kane/) | [GitHub](https://github.com/KrozisKane) :: map editing | ||
| - __ReservedRegister__ :: [GitHub](https://github.com/ReservedRegister) :: reverse engineering | ||
| - __raicovx__ :: [Github](https://github.com/raicovx) :: equipment persistence | ||
| - __Jimmy-Baby__ :: [Github](https://github.com/Jimmy-Baby) :: damage effects addon | ||
| - __Removiekeen__ :: [Steam](https://steamcommunity.com/profiles/76561198804614641/) :: logo design | ||
| - __yarik2720__ :: [Github](https://github.com/yarik2720) :: russian translation, ci/cd | ||
|
|
||
| ### External Libraries | ||
|
|
||
| - [SourceMod](https://github.com/alliedmodders/sourcemod) | ||
| - [SourceScramble](https://github.com/nosoop/SMExt-SourceScramble) | ||
| - [stocksoup](https://github.com/nosoop/stocksoup) | ||
| - [sm-logdebug](https://github.com/Alienmario/sm-logdebug) | ||
| - [smlib](https://github.com/bcserv/smlib/tree/transitional_syntax) | ||
| - __ampreeT__ :: programming, reverse engineering, map editing | ||
| - [Steam](https://steamcommunity.com/id/ampreeT) | [GitHub](https://github.com/ampreeT) | ||
| - __kasull__ :: programming, reverse engineering, trailer production | ||
| - [Steam](https://steamcommunity.com/id/kasull/) | [GitHub](https://github.com/kasullian) | ||
| - __Alienmario__ :: programming, reverse engineering, map editing | ||
| - [Steam](https://steamcommunity.com/id/4oM0/) | [GitHub](https://github.com/Alienmario) | ||
| - __Balimbanana__ :: programming, reverse engineering | ||
| - [Steam](https://steamcommunity.com/id/Balimbanana/) | [GitHub](https://github.com/Balimbanana) | ||
| - __Rock__ :: programming, map editing | ||
| - [Steam](https://steamcommunity.com/id/Rock48/) | [GitHub](https://github.com/Rock48) | ||
| - __Krozis Kane__ :: map editing | ||
| - [Steam](https://steamcommunity.com/id/Krozis_Kane/) | [GitHub](https://github.com/KrozisKane) | ||
| - __ReservedRegister__ :: reverse engineering | ||
| - [GitHub](https://github.com/ReservedRegister) | ||
|
|
||
| [__raicovx__](https://github.com/raicovx) :: Equipment persistence | ||
| | [__Jimmy-Baby__](https://github.com/Jimmy-Baby) :: Damage effects addon | ||
| | [__Removiekeen__](https://steamcommunity.com/profiles/76561198804614641/) :: logo design | ||
| | [__yarik2720__](https://github.com/yarik2720) :: CI, Russian translation | ||
|
|
||
| #### Third-party libraries | ||
| [SourceMod](https://github.com/alliedmodders/sourcemod) | ||
| | [SourceScramble](https://github.com/nosoop/SMExt-SourceScramble) | ||
| | [stocksoup](https://github.com/nosoop/stocksoup) | ||
| | [sm-logdebug](https://github.com/Alienmario/sm-logdebug) | ||
| | [smlib](https://github.com/bcserv/smlib/tree/transitional_syntax) |