Skip to content

Commit

Permalink
Wiki cleanup and updates
Browse files Browse the repository at this point in the history
  • Loading branch information
RDIL committed Jan 8, 2024
1 parent 9a673d7 commit 2f7943f
Show file tree
Hide file tree
Showing 18 changed files with 4,832 additions and 5,018 deletions.
1 change: 1 addition & 0 deletions .idea/peacockprojectorg.iml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion .node-version
Original file line number Diff line number Diff line change
@@ -1 +1 @@
16
18
877 changes: 0 additions & 877 deletions .yarn/releases/yarn-4.0.0-rc.44.cjs

This file was deleted.

6 changes: 4 additions & 2 deletions .yarnrc.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
compressionLevel: mixed

enableGlobalCache: false

nodeLinker: pnp

packageExtensions:
"@docusaurus/plugin-ideal-image@*":
dependencies:
prop-types: "*"

yarnPath: .yarn/releases/yarn-4.0.0-rc.44.cjs
20 changes: 2 additions & 18 deletions docs/credits.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,15 +38,7 @@ description: A tribute for all the people and work that has gone in to making Pe
</div>
<div className="card__body">
<small>
Hailing from New Zealand, Script, (also known as{" "}
<a
href="https://hitman.fandom.com/wiki/Sergei_Larin"
target="_blank"
rel="noopener noreferrer"
>
Sergei Larin
</a>
{" - "}
Hailing from New Zealand, Script, (also known as [Sergei Larin](https://hitman.fandom.com/wiki/Sergei_Larin),
the talented art forger) handles artwork and branding for Peacock.
Script enjoys expressing his unique art style and graphic design
skills by making our roadmaps and drawing.
Expand Down Expand Up @@ -283,15 +275,7 @@ description: A tribute for all the people and work that has gone in to making Pe
<small>
Hailing from Germany, CurryMaker helped build Peacock up in the
early days, developing crucial features like destinations pages and
escalations. These days, he frequently{" "}
<a
href="https://twitch.tv/CurryMakerTV"
target="_blank"
rel="noopener noreferrer"
>
streams on Twitch
</a>
.
escalations. These days, he frequently [streams on Twitch](https://twitch.tv/CurryMakerTV).
</small>
</div>
</div>
Expand Down
3 changes: 0 additions & 3 deletions docs/custom-content.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,6 @@ Peacock supports a broad variety of server side mods (plugins). These include, b
- Kill Everyone Mode
- All real NPC's marked as targets, can get Silent Assassin rating back after killing everyone.
- Note: Very buggy for maps with 200+ targets, guns may jam randomly. You may need to start by melee killing people.
- Sarajevo Six
- Bonus Missions otherwise only available in Hitman 2016 Playstation version.
- Installation Instructions: https://github.com/solderq35/hitman-tech-tips/blob/main/modding/sarajevo_six.md
- Brothers Elusive Target (Cut Content)
- File Download: https://www.nexusmods.com/hitman3/mods/375?tab=files
- Install the main portion of the mod (the file not marked "Peacock Plugin") through Simple Mod Framework. Install the "Peacock Plugin" portion of the mod by putting it into your Peacock Install folder. Read the Sarajevo Six instructions above for guidance if confused about either of those steps.
Expand Down
8 changes: 4 additions & 4 deletions docs/guides/linux-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ description: Guide for setting up Peacock on Linux or macOS.

Peacock is primarily built to work on Windows, but fear not, using it on Linux is possible!

## Update November 2022
:::info Update as of November 2022

Update as of November 2022:

- Go to [this Github repo](https://github.com/thepeacockproject/linux-steam-setup) for updated instructions on how to get Peacock running on Linux with Steam.
- Go to [this GitHub repo](https://github.com/thepeacockproject/linux-steam-setup) for updated instructions on how to get Peacock running on Linux with Steam.
- **Original Instructions below may also work.**

:::

## Server

To get the server working on Linux, you will need to first prepare Node.js.
Expand Down
10 changes: 6 additions & 4 deletions docs/intel/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,13 @@ description: How to get started with Peacock.

Here's how to get up and running with Peacock.

- Steps 2-3 may need to be repeated whenever Peacock receives an update (more info on the [Updating](./updating.md) page).
- Steps 4-5 need to be repeated every time you launch the game. The game defaults back to the official servers otherwise.

1. Be sure to check the [requirements](./requirements.md) before reading further to ensure you have the required games / operating systems. **Xbox Game Pass / Microsoft PC version of Hitman 3 is not supported**, and [Linux users should check this page](../guides/./linux-setup.md).
1. Be sure to check the [requirements](./requirements.md) before reading further to ensure you have the required games / operating systems. **Xbox Game Pass / Microsoft PC version of Hitman 3 is not supported**, and [Linux users should check this page](../guides/linux-setup.md).

2. [Download the latest Peacock release here](https://github.com/thepeacockproject/Peacock/releases/latest). Select `Peacock-vX.Y.Z.zip` to download.

- Note: There is also a `Peacock-vX.Y.Z-lite.zip` option, but this is mainly for Linux users. The lite version does not include Node, which Linux users have to download separate binaries for anyways. If in doubt / not on Linux, download the non-lite version.
- Refer to Step 1 for general Linux instructions.
- Note: There is also a `Peacock-vX.Y.Z-lite.zip` option, only for Linux users. Refer to the [Linux guide](../guides/linux-setup.md) for Linux instructions.

3. Extract (unzip) files. Running the files from within the zipped folder will not work.

Expand All @@ -22,3 +20,7 @@ Here's how to get up and running with Peacock.
- Depending on how you installed Peacock, you may need to open two folders to find these files, as shown in this example image: ![](/img/patcher_and_server.png).

5. Now start up the game while `Start Server` and `PeacockPatcher.exe` are still running. The game should launch with Peacock server. Check the [FAQ](./faq.md) or ask in the `#help` channel on [Peacock Discord](https://thepeacockproject.org/discord) if you have trouble getting it to work.

## Updating

Steps 2-3 may need to be repeated whenever Peacock receives an update (more info on the [Updating](./updating.md) page).
3 changes: 1 addition & 2 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ module.exports = {
onBrokenLinks: "warn",
onBrokenMarkdownLinks: "warn",
favicon: "/favicon.ico",
organizationName: "RDIL",
organizationName: "thepeacockproject",
projectName: "peacockprojectorg",
baseUrlIssueBanner: false,
i18n: {
Expand Down Expand Up @@ -163,7 +163,6 @@ module.exports = {
],
"@docusaurus/plugin-content-pages",
require.resolve("./src/search/plugin.js"),
require.resolve("./testimonialsPlugin.js"),
[
"@docusaurus/plugin-sitemap",
{
Expand Down
23 changes: 12 additions & 11 deletions i18n/en/code.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 0 additions & 3 deletions i18n/fi/code.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

62 changes: 29 additions & 33 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,29 +12,25 @@
"write-translations": "docusaurus write-translations",
"prettier": "prettier --write \"**/*.{js,md,html,json,css,cjs,mjs}\""
},
"resolutions": {
"react": "^17.0.2"
},
"dependencies": {
"@docusaurus/core": "^2.4.1",
"@docusaurus/module-type-aliases": "^2.4.1",
"@docusaurus/plugin-content-blog": "^2.4.1",
"@docusaurus/plugin-content-docs": "^2.4.1",
"@docusaurus/plugin-content-pages": "^2.4.1",
"@docusaurus/plugin-ideal-image": "^2.4.1",
"@docusaurus/plugin-sitemap": "^2.4.1",
"@docusaurus/theme-classic": "^2.4.1",
"@mdx-js/react": "^1.6.21",
"@svgr/webpack": "^8.0.1",
"@docusaurus/core": "^3.1.0",
"@docusaurus/module-type-aliases": "^3.1.0",
"@docusaurus/plugin-content-blog": "^3.1.0",
"@docusaurus/plugin-content-docs": "^3.1.0",
"@docusaurus/plugin-content-pages": "^3.1.0",
"@docusaurus/plugin-ideal-image": "^3.1.0",
"@docusaurus/plugin-sitemap": "^3.1.0",
"@docusaurus/theme-classic": "^3.1.0",
"@mdx-js/react": "^3.0.0",
"autocomplete.js": "^0.38.1",
"classnames": "^2.3.2",
"clsx": "^1.2.1",
"clsx": "^2.1.0",
"hogan.js": "^3.0.2",
"lunr": "^2.3.9",
"prettier": "^2.8.8",
"react": "^17.0.2",
"react-dom": "^17.0.0",
"webpack": "^5.83.1"
"react": "^18.2.0",
"react-dom": "^18.2.0",
"webpack": "^5.89.0"
},
"browserslist": {
"production": [
Expand All @@ -53,21 +49,21 @@
"semi": false
},
"devDependencies": {
"@docusaurus/types": "^2.4.1",
"@tsconfig/docusaurus": "^1.0.6",
"@types/node": "^20.2.3",
"@types/react": "^18.2.6",
"@types/react-dom": "^18.2.4",
"hast-util-select": "^4.0.0",
"hast-util-to-text": "^2.0.0",
"lunr-languages": "^1.12.0",
"minimatch": "^9.0.1",
"rehype-parse": "^7.0.1",
"to-vfile": "^6.1.0",
"typescript": "^5.0.4",
"unified": "^9.0.0",
"unist-util-is": "^4.0.2",
"unist-util-visit": "2.x"
"@docusaurus/types": "^3.1.0",
"@tsconfig/docusaurus": "^2.0.2",
"@types/node": "^20.10.7",
"@types/react": "^18.2.47",
"@types/react-dom": "^18.2.18",
"hast-util-select": "^6.0.2",
"hast-util-to-text": "^4.0.0",
"lunr-languages": "^1.14.0",
"minimatch": "^9.0.3",
"rehype-parse": "^9.0.0",
"to-vfile": "^8.0.0",
"typescript": "^5.3.3",
"unified": "^11.0.4",
"unist-util-is": "^6.0.0",
"unist-util-visit": "^5.0.0"
},
"packageManager": "yarn@4.0.0-rc.44"
"packageManager": "yarn@4.0.2"
}
52 changes: 0 additions & 52 deletions src/components/TestimonialsComponent.js

This file was deleted.

29 changes: 5 additions & 24 deletions src/pages/index.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import React from "react"
import clsx from "clsx"
import Layout from "@theme/Layout"
import Link from "@docusaurus/Link"
import styles from "./styles.module.css"
import OpenIcon from "../components/open-icon.svg"
import CustomLight from "../../static/img/home/CustomLight.svg"
Expand Down Expand Up @@ -105,29 +104,11 @@ function Home() {
</div>
</section>
)}
<section className={styles.bottomCardSpace}>
<div className={styles.buttons}>
<Link
className={clsx(
"button button--primary button--lg",
styles.fixedWidthBtn
)}
to="/testimonials"
>
<Translate
id="homepage.testimonialsButton"
description="The homepage's 'read what our users say' button."
>
Read what our users say
</Translate>
</Link>
</div>
</section>
<section
className={clsx(
styles.bottomCardSpace,
styles.bigCardSpace,
styles.enableGrid
styles.grid
)}
>
<h3
Expand All @@ -154,7 +135,7 @@ function Home() {
id="homepage.installationButton"
description="The text on the Installation button on the home page."
>
Check Installation Guide!
Read Installation Guide
</Translate>{" "}
<OpenIcon className={styles.icon} />
</a>
Expand All @@ -164,7 +145,7 @@ function Home() {
id="homepage.installationButtonBelowText"
description="The text below the Installation button on the home page."
>
(Read instructions before installing)
(Please read the instructions before installing)
</Translate>
</small>
<div
Expand Down Expand Up @@ -192,8 +173,8 @@ function Home() {
description="The text below the join our Discord button on the home page."
>
(Join our Discord for support, update notifications,
plugins to extend Peacock (new features, game
modes), and more!)
plugins to extend Peacock with new features and game
modes, and more!)
</Translate>
</small>
</section>
Expand Down
Loading

0 comments on commit 2f7943f

Please sign in to comment.