diff --git a/README.md b/README.md index 6205fc39..77ee5717 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,12 @@ # CoD4x Server [![build](https://github.com/callofduty4x/CoD4x_Server/actions/workflows/build.yml/badge.svg)](https://github.com/callofduty4x/CoD4x_Server/actions/workflows/build.yml) +

+ +

+ CoD4x is a modification of the Call of Duty 4 - Modern Warfare server. It fixes several bugs in the original binaries and allows developers to extend server functionality with additional variables and plugins. When using the CoD4x server, the clients invoke installation of the proprietary CoD4x client to players joining the server using the CoD4x servers, which fixes several known base game bugs in the client, and in combination with the server allows for extra features. A compatible client modification can be found here: [CoD4x_Client_pub](https://github.com/callofduty4x/CoD4x_Client_pub) -[Website](http://cod4x.ovh/) - [Forums](https://cod4x.ovh/index.php?/forums/) - [Documentation](http://docs.cod4x.ovh/) - [Masterserver](http://cod4master.cod4x.ovh/) +[Forums](https://cod4x.ovh) - [Masterserver](http://cod4master.cod4x.ovh/) ## The most prominent features are: * Administration commands @@ -38,14 +42,14 @@ To compile CoD4x from source, you need to install the following prerequisites: Debian/Ubuntu 32-bit: ``` -sudo apt install nasm build-essential +sudo apt install nasm make git ``` Debian/Ubuntu 64-bit: ``` sudo dpkg --add-architecture i386 sudo apt-get update -sudo apt-get install nasm:i386 build-essential gcc-multilib g++-multilib +sudo apt-get install nasm:i386 make gcc-multilib g++-multilib git ``` openSUSE 32-bit: @@ -75,7 +79,7 @@ If compilation was successful the binary will be placed in the `/bin/` folder. ## Contributing CoD4x is licensed under the AGPL3 license. We welcome anybody to fork this project and submit a pull request. -Plugins can be written in C/C++ and we also provide language bindings for D. The `/plugins` directory contains some example plugins. You can contribute to the project by developing plugins and create a pull request for them and/or uploading and promoting them on the [forums](https://cod4x.ovh/index.php?/forums/forum/5-server-plugins-and-management-tools/). +Plugins can be written in C/C++ and we also provide language bindings for D. The `/plugins` directory contains some example plugins. You can contribute to the project by developing plugins and create a pull request for them and/or uploading and promoting them on the [forums](https://cod4x.ovh/c/server-plugins-management-tools/8). If you want to contribute to the core project check the issue tracker for todos. We will try our best to keep the issue tracker filled with new bits. If you would like to work on a completely new feature, we would appreciate if you contact us first on the forums or on Github to discuss the idea. @@ -90,7 +94,7 @@ Aside from agreeing to the license, by making any use of CoD4x18 server you agre 2. The developers reserve the right to reuse your content as long as it is not used commercially. You have a right for your name/clan/website getting mentioned if this is going to happen. They can also use it on their own servers. -3. Maps you have installed on a server have to be either available on the internet already, or be made available to the community at the [CoD4x forums](https://cod4x.ovh/index.php?/forums/), with all required assets, like scripts, within 20 weeks of installation. You have to annouce your map on the [forums](https://cod4x.ovh/index.php?/forums/) on the same day you have installed it to gain the 20 weeks grace period. Not announced maps will have to be made available within 1 week. +3. Maps you have installed on a server have to be either available on the internet already, or be made available to the community at the [CoD4x forums](https://cod4x.ovh), with all required assets, like scripts, within 20 weeks of installation. You have to annouce your map on the [CoD4x forums](https://cod4x.ovh) on the same day you have installed it to gain the 20 weeks grace period. Not announced maps will have to be made available within 1 week. 4. Plugins have to be made available as sourcecode so the user can interact with it diff --git a/README.txt b/README.txt deleted file mode 100644 index 6b728d2a..00000000 --- a/README.txt +++ /dev/null @@ -1,64 +0,0 @@ -CoD4X18-Server -================ - -A custom dedicated server for the Call of Duty 4 game. - -If you find any bugs, please create an issue here on github. - - -COPYRIGHT -========= -CoD4X is copyrighted by Ninja and TheKelm -Large portions of CoD4X are copyrighted by "Id Software, Inc." -Several portions are part of the "ioQuake-3 project". -unzip is copyrighted by Gilles Vollant, Jean-loup Gailly and Mark Adler -LibTomCrypt is copyrighted Tom St Denis. -LibTomMath is copyrighted Tom St Denis. -maxmind_geoip.c is copyrighted by "MaxMind LLC". - -LICENSE -======= - -CoD4X is released under GNU Affero General Public License, see copying.txt - -Plugin Handler is released under GNU Affero General Public License, see copying.txt (if you want to request another license on Plugin Handler API for your plugin, contact us) - -Other: - --LibTomMath and LibTomCrypt libraries are public domain, available at http://libtom.org/ - --unzip.c is part of zlib and contains own license agreements you can find below: - -IO on .zip files using portions of zlib ---------------------------------------------------------------------------- -lines file(s) -4301 src/qcommon/unzip.c -Copyright (C) 1998 Gilles Vollant -zlib is Copyright (C) 1995-1998 Jean-loup Gailly and Mark Adler - - This software is provided 'as-is', without any express or implied - warranty. In no event will the authors be held liable for any damages - arising from the use of this software. - - Permission is granted to anyone to use this software for any purpose, - including commercial applications, and to alter it and redistribute it - freely, subject to the following restrictions: - - 1. The origin of this software must not be misrepresented; you must not - claim that you wrote the original software. If you use this software - in a product, an acknowledgment in the product documentation would be - appreciated but is not required. - 2. Altered source versions must be plainly marked as such, and must not be - misrepresented as being the original software. - 3. This notice may not be removed or altered from any source distribution. - - - - - - - -CONTACT -======= - -https://cod4x.ovh diff --git a/assets/github/banner.png b/assets/github/banner.png new file mode 100644 index 00000000..ca6dfdef Binary files /dev/null and b/assets/github/banner.png differ diff --git a/changelog.txt b/changelog.txt deleted file mode 100644 index bbf5dc46..00000000 --- a/changelog.txt +++ /dev/null @@ -1,47 +0,0 @@ - - -July 7 2013: - -Code_CallbackPlayerSay*: Added 2nd argument (to entity) - -August 11 2013 -Code_CallbackPlayerSay*: 2nd argument = boolean teamchat -> false: toall true: onlyteam - - -Hmm I was too lazy to write anything... - -February 3 2014: - -CodeCallback_PlayerSayCmd is removed. -CodeCallback_PlayerSayAll is renamed to CodeCallback_PlayerSay. -CodeCallback_ScriptCommand added as well as script function: addscriptcommand() - -Fixed an issue that cheatprotected cvars got no reset on level startup which caused strange effects on Deathrun mod with bg_falldamage cvars. - -June 22 2014: -Removed chat trap for script when a command gets invoked. -Use CodeCallback_ScriptCommand and addscriptcommand() instead (see scriptcommand_example.txt) - -Added securemode which should prevent breaking out of cod4 server into shell. - - -June 29 2014: -Removed the non working recusion callback function for player's chat. Use plugins instead. - -July 27 2014: -exec() script function now returns the result as string truncated - Maybe this functionality getting removed later again if issues arise - -September 09 2014: -exec is now execex -exec works like before July 27 2014 - -September 12 2016: -After a 2 years its still good to write about changes in server code ^^ - - 'SetText' script command now safe to use with dynamically created strings like player names, number increments and etc. - - 'ClearAllTextAfterHudElem' script command now can be used only in developer mode because of its bugs. - -September 13 2016: - + Added 'Scr_AddArrayKey' script and plugin function. It allows you to create script arrays with string keys instead of numeric. Just make sure you passed value returned from 'Scr_AllocString' (call this one on initialization). - -September 14 2016: - + Added 'isArray' script function. (http://zeroy.com/script/variables/isarray.htm) \ No newline at end of file diff --git a/copying.txt b/copying.md similarity index 100% rename from copying.txt rename to copying.md