Skip to content

Commit

Permalink
Add video tutorial
Browse files Browse the repository at this point in the history
  • Loading branch information
RDIL committed Aug 4, 2024
1 parent 5643e66 commit 8ab46d4
Show file tree
Hide file tree
Showing 6 changed files with 37 additions and 4 deletions.
6 changes: 6 additions & 0 deletions docs/features/progression-transfer.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@ Peacock supports transferring your progress from official World of Assassination
We currently only support same game and platform, for example, you can only go from Hitman 3 Steam → Hitman 3 Steam.
Support for cross-game progression transfer is planned.

## Video Tutorial

<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/nF5ngiuDe5M?start=201" title="YouTube video player" frameborder="0" allow="autoplay; encrypted-media; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen="true"></iframe>

Check out the video tutorial above for a walkthrough of the progression transfer process. It may help to enable full-screen mode!

## How do I do it?

1. First, Start Peacock. Then connect to Peacock with the game. It is recommended that you now close the game.
Expand Down
10 changes: 10 additions & 0 deletions docs/intel/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,16 @@ title: Installation and Usage
description: How to get started with Peacock.
---

## Installation

### Video Tutorial

<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/nF5ngiuDe5M?start=92" title="YouTube video player" frameborder="0" allow="autoplay; encrypted-media; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen="true"></iframe>

Check out the video tutorial above for a walkthrough of the installation process. It may help to enable full-screen mode!

### Instructions

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

- Steps 4-5 need to be repeated every time you launch the game. The game defaults back to the official servers otherwise.
Expand Down
6 changes: 6 additions & 0 deletions docs/intel/requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@ title: Requirements
description: Requirements for running and using Peacock.
---

:::tip Video Tutorial

Want this guide in video/spoken form? Check out our [video tutorial](https://www.youtube.com/watch?v=nF5ngiuDe5M).

:::

## Supported Games / Platforms

- Hitman 2016 ([Steam](https://store.steampowered.com/app/236870/HITMAN/) / [Epic](https://www.epicgames.com/store/en-US/p/hitman))
Expand Down
12 changes: 10 additions & 2 deletions docs/intel/updating.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,18 @@ title: Updating to New Versions
description: When should I update? How do I update? A guide on everything you need to know about updating.
---

1. When you run `Start Server.cmd`, you may get an alert that Peacock is out of date, as shown in this example image: ![](/img/peacock_out_of_date.png).
## Video Tutorial

<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/nF5ngiuDe5M?start=484" title="YouTube video player" frameborder="0" allow="autoplay; encrypted-media;picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen="true"></iframe>

Check out the video tutorial above for a walkthrough of the updating process. It may help to enable full-screen mode!

## Instructions

1. When you run `Start Server.cmd`, you may get an alert that Peacock is out of date, as shown in this example image: ![Out of date Peacock warning](/img/peacock_out_of_date.png).
2. Usually you will need to update Peacock only when there is a new game update, but stay tuned in the Peacock Discord's `#updates` and `#downloads` channels to be safe.
- Note: Peacock may be temporarily unavailable after a game update, as it takes a few hours for the Peacock Patcher to be updated as well.
3. If there is a new Peacock update, go to the [latest Peacock release on Github](https://github.com/thepeacockproject/Peacock/releases/latest) to download the latest build.
3. If there is a new Peacock update, go to the [latest Peacock release on GitHub](https://github.com/thepeacockproject/Peacock/releases/latest) to download the latest build.
4. Extract (unzip) files. Running the files from within the zipped folder will not work.
5. **Assuming you have used Peacock during the previous game update**, follow the instructions below to keep your loadouts and in-game save files (Otherwise, your loadouts will all default back to ICA19/coins/fiberwire, and your in-game save files will be lost).

Expand Down
4 changes: 2 additions & 2 deletions docs/intel/what-is-peacock.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ Here's a brief breakdown of what Peacock does:
- **By default, progression / challenge completion is turned on to simulate an official servers experience.**
- **You can reset progress (challenges, XP, mastery, etc) at any time** by deleting your `userdata` folder within your Peacock Install directory.
- If it is your first time playing (on either Peacock or official servers), some exits will be locked. You will need to unlock Dubai exits ([need to unlock the elevators](https://youtu.be/IEQgRQyQRf8)), Dartmoor exits ([need to exit via bike at least once](https://youtu.be/AJtJZe9jEi8?t=151)), and Colorado exits ([need to use tornado exit at least once](https://youtu.be/3XKWHrKpXwk?t=140)). These exits are handled client-side.
- Peacock lets you play [custom](.././custom-content.md) or otherwise discontinued / time limited content such as [Ghost Mode](.././ghost-mode.md), Sniper co-op, escalations, elusive targets, and contracts.
- Both official server escalation / elusive targets / contracts and custom / modded ones are supported, see [here](.././custom-content.md) for more info.
- Peacock lets you play [custom](../custom-content.md) or otherwise discontinued / time limited content such as [Ghost Mode](../ghost-mode.md), Sniper co-op, escalations, elusive targets, and contracts.
- Both official server escalation / elusive targets / contracts and custom / modded ones are supported, see [here](../custom-content.md) for more info.
- Display leaderboards for other Peacock users (Cross Platform, Epic and Steam)
- In Game Saving is supported, and as of Peacock v5.0.1 you can load official server saves in Peacock.

Expand Down
3 changes: 3 additions & 0 deletions docusaurus.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,9 @@ export default {
content: "peacock,project,hitman,server,replacement,offline"
}
],
announcementBar: {
content: "<b>Check out our new <a href=\"https://www.youtube.com/watch?v=nF5ngiuDe5M\">official video tutorial on YouTube</a>!</b>",
},
navbar: {
logo: {
src: "/img/feather.png",
Expand Down

0 comments on commit 8ab46d4

Please sign in to comment.