mirror of
https://github.com/thepeacockproject/Peacock
synced 2024-12-05 20:15:16 +01:00
76 lines
2.5 KiB
Markdown
76 lines
2.5 KiB
Markdown
# The Peacock Project
|
|
|
|
[](https://discord.gg/peacock)
|
|
|
|
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](https://nodejs.org/en/). 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](https://www.jetbrains.com/webstorm/) for
|
|
development,
|
|
but it is a paid product, so you may want to choose something
|
|
like [Visual Studio Code](https://code.visualstudio.com/).
|
|
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](https://gitlab.com/grappigegovert/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](https://ioi.dk), and is not affiliated
|
|
with this project in any way.
|