Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions docs/modding/hitman/customcampaigns/_category_.json

This file was deleted.

Binary file not shown.
4 changes: 4 additions & 0 deletions docs/modding/hitman/guides/customcampaigns/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Custom Campaign and Missions",
"position": 3
}
Original file line number Diff line number Diff line change
Expand Up @@ -45,19 +45,19 @@ In the `chunk0` folder, create a folder named `Story Config`. In that folder cre
> **_Note:_** The extension on this file is case-sensitive, so the file must end in `.JSON.patch.json`.

### Explanation:
* This is a json patch file for `0093B70B9E704CE0`, which is the `[assembly:/_pro/online/default/cloudstorage/resources/storyconfig.json].pc_json` file, which is where the campaigns are defined.
* This is a json patch file for `0093B70B9E704CE0`, which is the `[assembly:/_pro/online/default/cloudstorage//img/customcampaigns/storyconfig.json].pc_json` file, which is where the campaigns are defined.
* This adds a new campaign, with the `Name` being the value set in the `manifest.json` for `UI_HITMAN_CAMPAIGN_DEMO`.
* It sets the `BackgroundImage` for the campaign to be a custom image that will be displayed for the campaigns button on the menu.
* It also adds one mission to that campaign, with the `Id` for that mission being the `Id` defined in the metadata for the bank mission.
* Replace `[INSERT GENERATED UUID HERE]` with a new UUID. You can generate one using GlacierKit in the `Text tools` section on the left sidebar:
![resources/randomUuid.jpg](resources/randomUuid.jpg)
![/img/customcampaigns/randomUuid.jpg](/img/customcampaigns/randomUuid.jpg)

## Creating the Background Image for the custom campaign mod
Create another folder in your root folder named `blobs`. In that folder, create another folder named `images`, and in that folder, another folder named `campaign_demo`. This structure will make it more organized for when you want to add more images later.

Create a background image and put it in your `blobs/images/campaign_demo` folder.

![campaign_demo_tile_template.jpg](resources/campaign_demo_tile_template.jpg)
![campaign_demo_tile_template.jpg](/img/customcampaigns/campaign_demo_tile_template.jpg)
Here is an example you can use for the `campaign_demo_tile.jpg` file

## Next Steps
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ For this tutorial, we will go over creating a custom scene file and a custom sce
## Downloading the scenario file from the template

The [Custom-Scenes templates](https://github.com/NotexMods/Custom-Scenes/tree/main/templates) page contains a template for a Scenario Brick, which is copied here for convenience.
* [Scenario brick](resources/empty_scenario_brick.entity.json)
* [Scenario brick](/files/customcampaigns/empty_scenario_brick.entity.json)

For each mission, it is best practice to create both a Scene and Scenario `entity.json` file for reusability, though not strictly necessary. We will be following that methodology for this guide.

Expand All @@ -33,7 +33,7 @@ For the Bank mission, we will need to have Simple Mod Framework (SMF) put these
To find the correct chunk for the Bank mission, let's look at the [Chunk Data](/docs/modding/hitman/guides/locating_locations.md) page.

Scrolling down to the `Hitman 3` table, we can see that the `New York` location is in `Chunk 12`.
![resources/chunk_data.jpg](resources/chunk_data.jpg)
![/img/customcampaigns/chunk_data.jpg](/img/customcampaigns/chunk_data.jpg)

Create a new folder in the root mod folder named `bank`. In that folder, create a new folder named `chunk12`.

Expand All @@ -43,7 +43,7 @@ In GlacierKit, open the `manifest.json` file and update the `contentFolders` arr

In GlacierKit, right-click the `bank/chunk12` folder and click `New File` and set the name to `scene_bank.entity.json`. Since we gave it a name that ends with `.entity.json`, GlacierKit will initialize the file with the entity template.

Right click [Scenario brick](resources/empty_scenario_brick.entity.json) and press `Save link as...` and save it into your `bank/chunk12` folder with a name of `scenario_bank.entity.json`.
Right click [Scenario brick](/files/customcampaigns/empty_scenario_brick.entity.json) and press `Save link as...` and save it into your `bank/chunk12` folder with a name of `scenario_bank.entity.json`.

## Setting the factory and blueprint hashes for the scene
Now we have our scene and scenario files, but the game doesn't know to tie them to the IOI strings that we created. We can fix that by setting the `Factory hash` and `Blueprint hash` for these files.
Expand Down Expand Up @@ -77,7 +77,7 @@ In GlacierKit, while still on the `Metadata` tab for `scene_bank.entity.json`, c
`[assembly:/_pro/scenes/missions/hitman_campaign_demo/mission_bank/scenario_bank.brick].pc_entitytype`
and click the `Continue` button.

![resources/externalScenes.jpg](resources/externalScenes.jpg)
![/img/customcampaigns/externalScenes.jpg](/img/customcampaigns/externalScenes.jpg)

Now that we have set the `Factory hash` and `Blueprint hash`, and added the scenario to the `External scenes`, we are done with the Scene file. Save the file by pressing the save icon in the tab, or Ctrl+S (if you are on windows). Let's move on to the scenario itself.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ In this example we will be creating a custom campaign named `Hitman Campaign Dem

To start off with, create an account on [github.com](https://github.com) if you don't have one already. Then go to the
[smf mod template](https://github.com/atampy25/smf-mod) and click the `Use this template` button:
![resources/use_this_template.jpg](resources/use_this_template.jpg)
![/img/customcampaigns/use_this_template.jpg](/img/customcampaigns/use_this_template.jpg)
Click the `Create a new repository` link. Enter `HitmanCampaignDemo`
(or your desired campaign name). In the description we'll put `A custom Hitman: World of Assassination campaign`. Set it
to Public or Private and click the `Create repository` button.
Expand All @@ -41,7 +41,7 @@ To get this mod on your local computer, you will need to clone this repository.
1. Fedora-like: run `sudo dnf install git-all`.
2. Debian-based: run `$ sudo apt install git-all`.
2. Go to your mod repo's page on GitHub and click the green `Code` button near the top right of the page, and click the copy icon next to the url:
![resources/copy_to_clipboard.jpg](resources/copy_to_clipboard.jpg)
![/img/customcampaigns/copy_to_clipboard.jpg](/img/customcampaigns/copy_to_clipboard.jpg)
3. Open a new terminal in the `[HITMAN DIRECTORY]/Simple Mod Framework/Mods` directory.
4. Run `git clone [URL from clipboard]`.

Expand Down
Loading
Loading