1
mirror of https://github.com/thepeacockproject/Peacock synced 2024-11-22 22:12:45 +01:00
Go to file
2023-04-22 10:13:26 +01:00
.github Additionally target v7 PRs 2023-04-02 01:07:45 -04:00
.idea Significant performance improvement that I have not actually tested 2023-01-28 21:59:26 -05:00
.vscode Update some vscode settings 2022-11-10 03:49:47 +01:00
.yarn TypeScript v5 2023-04-08 22:29:40 -04:00
components Fixed a nullability issue (#243) 2023-04-22 10:13:26 +01:00
contractdata Add support for Elusive Target Arcade (#209) 2023-04-21 18:48:56 +01:00
docs Move the code of conduct to the docs folder [skip ci] 2023-01-04 11:33:58 -05:00
packaging Bump SMP version to v5.6.1 2023-04-20 12:36:43 +01:00
patcher Initial commit 2022-10-19 21:33:45 -04:00
plugins Added logic to generate require table for plugins 2023-04-17 00:24:13 +02:00
resources Update localisation RPKGs 2023-04-21 20:04:32 +01:00
static Update pickup template (#242) 2023-04-22 10:12:53 +01:00
tests Fixed an issue where refresh_token was not properly served (#190) 2023-04-06 21:47:08 +01:00
webui Add support for Elusive Target Arcade (#209) 2023-04-21 18:48:56 +01:00
.cirrus.yml Add a CI task to run the tests 2023-04-08 22:46:51 -04:00
.editorconfig Initial commit 2022-10-19 21:33:45 -04:00
.eslintignore Initial commit 2022-10-19 21:33:45 -04:00
.eslintrc.js Add support for compiling plugins from TS to JS 2023-04-16 15:10:06 +02:00
.gitattributes Fix the gitattributes 2022-12-02 12:01:29 -05:00
.gitignore Refactor localisation to use one file 2023-04-21 18:08:43 +01:00
.nvmrc Node 18.15.0 2023-04-02 00:35:02 -04:00
.prettierignore Add support for logging to console and files (#159) 2023-03-26 14:59:57 -04:00
.yarnrc.yml TypeScript v5 2023-04-08 22:29:40 -04:00
LICENSE Initial commit 2022-10-19 21:33:45 -04:00
package.json Refactor localisation to use one file 2023-04-21 18:08:43 +01:00
PeacockPatcher.exe Initial commit 2022-10-19 21:33:45 -04:00
readme.md Prettier readme 2023-04-21 18:14:47 +01:00
tsconfig.json Refactor localisation to use one file 2023-04-21 18:08:43 +01:00
webstorm.config.js Update copyright years to 2023 2023-01-23 13:37:33 -05:00
yarn.lock Bump SMP version to v5.6.1 2023-04-20 12:36:43 +01:00

The Peacock Project

Discord

The Peacock Project is a HITMAN World of Assassination Trilogy server replacement. The primary purpose is preservation of the game, but it also adds new features and content to the game, and allows for other enhancements to be made while in online mode.

Installation

Install Node.js. Use the Latest version, or the version specifically mentioned here: Version 18

Clone the repository where-ever you wish.

Open Windows terminal AS ADMINISTRATOR.

Install Yarn, by typing:

corepack enable

Then move to the folder where you cloned the repo to by using:

cd Folder/Path/Here

then install the dependencies by using:

yarn install

Usage

The project is bundled with a server running configuration. Run that when editing the project with the IDE of choice, and it should open.

We highly suggest you use WebStorm for development, but it is a paid product, so you may want to choose something like Visual Studio Code. WebStorm will provide a better experience for development, but VSCode will work just fine.

Contributing

To contribute, you can use Pull Requests from your own fork. You can fix bugs reported in issues or add new features you think would be useful, new features not listed in issues would have to be discussed before merging.

To update localisation files, edit locale.json in the resources folder. If adding new strings, make sure to add the English versions to all languages. If you are translating existing strings, you only need to translate ones that are in that language. Then make sure rpkg_cli.exe, HMLanguageTools.exe, and ResourceLib_*.dll are in the resources folder. Then, from the root project folder, run yarn rebuild-locale and push the new RPKGs and edited locale JSON files.

Thank you to people who have contributed!

License

Peacock is under the AGPL-3.0 license, see the license file for more info.

Credits

Peacock started off as a fork of LocalGhost by grappigegovert, and has since been rewritten in TypeScript, and a whole host of new features have been added. The codebase has been relicensed to AGPL-3.0 with explicit permission from grappigegovert.

The game is owned by IO Interactive, and is not affiliated with this project in any way.