Skip to content

Commit

Permalink
Fixed some typos
Browse files Browse the repository at this point in the history
  • Loading branch information
jamiephan committed Aug 16, 2024
1 parent 73f8e02 commit 488866c
Show file tree
Hide file tree
Showing 7 changed files with 23 additions and 20 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,19 @@

<!-- This file enables applying a permanent armor by adding the behavior of: -->

<!-- PermaKArmor -->
<!-- PermaKPhysicalArmor -->
<!-- PermaKSpellArmor -->
<!-- PermaNArmor -->
<!-- PermaNPhysicalArmor -->
<!-- PermaNSpellArmor -->

<!-- Where K can be a numebr between -75 to 75 -->
<!-- E.g Perma10SpellArmor = Permanent 10 Spell Armor -->
<!-- Perma-75Armor = Permanent -75 Spell Armor-->
<!-- Where N can be a number between -75 to 75 -->
<!-- E.g Perma10SpellArmor = Permanent 10 Spell Armor -->
<!-- Perma-75Armor = Permanent -75 Armor -->
<!-- Perma-50PhysicalArmor = Permanent -50 Physical Armor -->

<!-- Yes, XML id key allow hyphen (-) symbol -->
<!-- (Yes, XML id key allow hyphen (-) symbol) -->

<!-- To apply in game, add the behaviour to the unit, or use the chat command: -->
<!-- "addbehavior" - "adb Perma-75Armor", "adb Perma10SpellArmor" -->

<!-- ================================================================================== -->

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="us-ascii"?>
<Catalog>
<!-- This file does absolutly nothing but for testing the Generate XML tool.
<!-- This file does absolutely nothing but for testing the Generate XML tool.
As well as force git to upload the empty directory.
You can delete this file at any will and do a "npm run buildxml"
You can delete this file at any will and do a "npm run build:xml"
or manually update the GameData.xml file. -->
</Catalog>
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="us-ascii"?>
<Catalog>
<!-- This file does absolutly nothing but for testing the Generate XML tool.
<!-- This file does absolutely nothing but for testing the Generate XML tool.
As well as force git to upload the empty directory.
You can delete this file at any will and do a "npm run buildxml"
You can delete this file at any will and do a "npm run build:xml"
or manually update the GameData.xml file. -->
</Catalog>
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ A modified Try Mode Map for [Heroes of the Storm](https://heroesofthestorm.com/)

---

To get started, please see the project page: https://jamiephan.github.io/HeroesOfTheStorm_TryMode2.0/
## To get started, please visit the project page: https://jamiephan.github.io/HeroesOfTheStorm_TryMode2.0/
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ Currently, there are two ways to load a custom map:
- Replacing in-game single player maps (Tutorial maps, Try Mode):
- The in game single player maps was loaded from CASC (Blizzard's game file storage) storage: `mods/heroes.stormmod/base.stormmaps/maps/heroes/singleplayermaps/(10)trymemode.stormmap`. However due to how StarCraft II's engine works, the game will attempt to priorities loading from `Heroes of the Storm Installation/maps` folder before CASC, therefore, this modified map can be "side-loaded" into the game without modifying the CASC storage (which is against the EULA).
- Run a `.stormmap` file directly:
- The game allows to run a `.stormmap` file, which is a modified version of `.sc2map` from StarCraft 2 and it is paclaged in a [MPQ format](http://www.zezula.net/en/mpq/main.html). Simply just run the map with `"HeroesSwitcher_x64.exe <path>"`, where path is the *absolute* path to the `.stormmap` file. Note that unlike usual command line applications where relative path is relative to your working directory, Heroes treats relative path as it is from CASC. So the "relative" path of the `<Path>` argument is relative to `mods/heroes.stormmod/base.stormmaps/maps` (CASC) or `Heroes of the Storm Installation/maps`(File System).
- The game allows to run a `.stormmap` file, which is a modified version of `.sc2map` from StarCraft 2 and it is packaged in a [MPQ format](http://www.zezula.net/en/mpq/main.html). Simply just run the map with `"HeroesSwitcher_x64.exe <path>"`, where path is the *absolute* path to the `.stormmap` file. Note that unlike usual command line applications where relative path is relative to your working directory, Heroes treats relative path as it is from CASC. So the "relative" path of the `<Path>` argument is relative to `mods/heroes.stormmod/base.stormmaps/maps` (CASC) or `Heroes of the Storm Installation/maps`(File System).

> Note that both methods allow loading the map which are either a file, folder, or a symbolic link of both, as long as the name is ending in `.stormmap`.
Expand Down Expand Up @@ -126,7 +126,7 @@ It have various functionalities such as switch heroes, level, etc, which can sav

Base on the naming of the internal variables, I assume this is for QA testers. To use it, type `-devcheats` in the chat (on either Ally or All chats only).

>Note: In a recent commit, I have sync the `/` key with QA Cheat menu and Debug menu, which means the `/` key will open both debug and QA menu together. I am considering should I "desync" them.
>Note: In a recent commit, I have sync the `/` key with QA Cheat menu and Debug menu, which means the `/` key will open both debug and QA menu together. I am considering should I "de-sync" them.
Here is a quick look of the QA cheat menu:

Expand Down
6 changes: 3 additions & 3 deletions docs/tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ To do so, just simply add the behavior to the selected units (e.g using the [cha

Also note that some abilities have special requirements, such as ultimates requires `Ultimate2Unlocked` or `Ultimate2Unlocked` behavior, you will need to also add them to the units as well (e.g chat command `adb Ultimate2Unlocked`). Details on each abilities requirements will be shown inside the generated XML file.

>Note: After generation, it will run a function similar to `npm run buildxml` once, since its a XML mod after all.
>Note: After generation, it will run a function similar to `npm run build:xml` once, since its a XML mod after all.
Generated XML file location: `./(10)trymemode.stormmap/base.stormdata/Mods/GameData/HeroesMod/AbilityMimic.xml`

Expand All @@ -118,7 +118,7 @@ This will generate an ability with the prefixed `MB`. For instance, the behavior

>Note: This will also respect the game settings, e.g Stuns and Silences will disable hotkey bars. Therefore it is not recommended to use `MBPermaStun` (Behavior Buff: `PermaStun`) or `MBPermaSilence` (Behavior Buff: `PermaSilence`) since you cannot active again to cancel it. You will need to respawn / remove the behavior (not the ability but actual behavior buff) if you would like to regain control.
>Note: After generation, it will run a function similar to `npm run buildxml` once, since its a XML mod after all.
>Note: After generation, it will run a function similar to `npm run build:xml` once, since its a XML mod after all.
Generated XML file location: `./(10)trymemode.stormmap/base.stormdata/Mods/GameData/HeroesMod/AbilityMimic.xml`

Expand All @@ -136,7 +136,7 @@ This tool will search though all the `<CModel>` and map it to a `<CUnit>`, which

This will generate a unit with the prefixed `UN`. For instance, the model `RetreatPing` (White Flag retreat ping model) will have a unit `UNRetreatPing`, which you can summon this unit using tools such as [summon](usage.md#cmd-summon), with the command of `summon UNRetreatPing`.

>Note: After generation, it will run a function similar to `npm run buildxml` once, since its a XML mod after all.
>Note: After generation, it will run a function similar to `npm run build:xml` once, since its a XML mod after all.
Generated XML file location: `./(10)trymemode.stormmap/base.stormdata/Mods/GameData/HeroesMod/ModelMimic.xml`

Expand Down
6 changes: 3 additions & 3 deletions scripts/main/buildmimicabilities.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@ const idPrefix = 'M';

let finalXML = '<?xml version="1.0" encoding="us-ascii"?>\n\n';
finalXML += '<!-- ======================================================== -->\n';
finalXML += '<!-- This file is generated via "npm run buildmimicabilities" -->\n';
finalXML += '<!-- This file is generated via "npm run build:mimicabilities" -->\n';
finalXML += '<!-- ======================================================== -->\n';
finalXML += '<!-- It will find all <CAbil*> and map to a <CBehaviorAbility>, -->\n';
// eslint-disable-next-line max-len
finalXML += '<!-- That enabled most abilities to be added with behavior, as an item like ice block. -->\n';
finalXML += '<!-- To prevent collision, all Mimic Abilties\'s id will have prefixed "M" -->\n';
finalXML += '<!-- To prevent collision, all Mimic Abilities\' id will have prefixed "M" -->\n';
// eslint-disable-next-line max-len
finalXML += '<!-- Some Abilites required a specific behavior to be unlocked, which will shown next to the ability below. -->\n';
finalXML += '<!-- Some Abilities required a specific behavior to be unlocked, which will shown next to the ability below. -->\n';
finalXML += '<!-- Such as "Ultimate1Unlocked" for ultimates -->\n';
finalXML += '<!-- Please also manually add the behavior to the units. -->\n';
finalXML += '\n<Catalog>\n';
Expand Down

0 comments on commit 488866c

Please sign in to comment.