creating a new page and setting up a tutorial section

azerothcore · Jan 11, 2025 · e0e5c0d · e0e5c0d
1 parent 992c2c4
commit e0e5c0d
Show file tree

Hide file tree

Showing 5 changed files with 85 additions and 75 deletions.
diff --git a/assets/images/tutorials/game_event_example/no-npcs.png b/assets/images/tutorials/game_event_example/no-npcs.png
diff --git a/assets/images/tutorials/game_event_example/npcs.png b/assets/images/tutorials/game_event_example/npcs.png
diff --git a/docs/documentation-index.md b/docs/documentation-index.md
@@ -57,6 +57,10 @@ redirect_from: /documentation_index
 * [Wypoint information](waypoints-information)
 * [How to obtain free records](how-to-obtain-free-records)
 
+## Tutorials
+
+* [How To Use Game Events](how-to-use-game-events)
+
 ## Extend AzerothCore
 
 * [The Modular Structure](the-modular-structure)

diff --git a/docs/game_event.md b/docs/game_event.md
@@ -67,78 +67,3 @@ This is a boolean field that determines if this game event is a world event or n
 | 1     | Announce the description of the Event to the world |
 | 2     | Use the `event.announce` settings from the config  |
 
-## Example
-
-(**Note:** make a database backup before making any changes to your database.)
-
-Below are some SQL changes that can be made to the \`acore_world\` database that will cause three "Defias Cutpurse" NPCs appear and disappear every two (2) minutes from Elwynn Forest. This is designed to be a simple example and doesn't represent an improvement to the game world in anyway.
-
-We're going to assume you're using the `mysql` commandline tool to manipulate the database, but you can use any tool you want that lets you run custom SQL queries.
-
-Login to the game world using the WoW client and start by teleporting to the area we intend on working in. Use the following GM command, which might require `.gm on` first: `.go xyz -9168.486 86.90783 77.05649 0 0.006`. You'll see three NPCs walking around a tent, like this:
-
-![npcs](https://github.com/user-attachments/assets/d0ecbb52-dd0d-453c-824e-bd13f4f6a791)
-
-Next, connect to the AzerothCore MySQL database and ensure you're using the correct table: \`use acore_world\`.
-
-Next, apply the following SQL to create a new event with ID 91 to your world (**note**: this will delete any existing event entry with an ID of 91):
-
-```sql
-DELETE FROM game_event WHERE eventEntry = 91;
-INSERT INTO game_event (
-	eventEntry,
-	start_time,
-	end_time,
-	occurence,
-	length,
-	holiday,
-	holidayStage,
-	description,
-	world_event,
-	announce
-) VALUES (
-	91,
-	"2000-01-01 14:00:00",
-	"2030-12-31 14:00:00",
-	2,
-	1,
-	0,
-	0,
-	"TESTING EVENT",
-	0,
-	1
-);
-```
-
-This triggers once every `occurence` minutes or `2` minutes in this case. The event will last for `length` minutes or `1` minute for us, which means after one (`1`) minute the NPCs will be added back into the game world.
-
-Now update the `game_event_creature` table by applying the following SQL:
-
-```sql
-DELETE FROM game_event_creature WHERE guid=79888;
-DELETE FROM game_event_creature WHERE guid=79889;
-DELETE FROM game_event_creature WHERE guid=79890;
-
-INSERT INTO game_event_creature (eventEntry,guid) VALUES (-91,79888);
-INSERT INTO game_event_creature (eventEntry,guid) VALUES (-91,79889);
-INSERT INTO game_event_creature (eventEntry,guid) VALUES (-91,79890);
-```
-
-This defines the specific NPCs GUIDs we want the game event to **despawn** _from_ the world for us. It doesn't spawn the creatures as they already exist. There are other `game_event_*` tables for managing other things too, much more complex things, but we're just selecting this table as it's an easy one to work with and use to demonstrate how events work. Note that we've set the `eventEntry` field to a **negative** value -- that is `-91` -- and not (positive) `91` because we want this event to **delete** the NPCs. Don't worry, when the event ends after `length` minutes, the NPCs will be respawned again. If you want the event to spawn creatures you've defined, then you'd a positive GUID.
-
-Finally restart your AzerothCore world server. Because the game world has been restarted, and you had to log back into the game, you will have missed the first run of the event and therefore the announcement (which is set to `1` in our example SQL, above.) This means depending on how fast you teleport to the coordinates above, you may find the NPCs are still there or may have been removed.
-
-When you hang around the area at the coordinates from above, you'll eventually see the NPCs despawn:
-
-![no-npcs](https://github.com/user-attachments/assets/159cd3c5-3863-449f-a9a8-4f318fe7589c)
-
-If you want to now remove this event from your database, the following SQL can be used:
-
-```sql
-DELETE FROM game_event WHERE eventEntry = 91;
-DELETE FROM game_event_creature WHERE guid=79888;
-DELETE FROM game_event_creature WHERE guid=79889;
-DELETE FROM game_event_creature WHERE guid=79890;
-```
-
-Have fun!
diff --git a/docs/how-to-use-game-events.md b/docs/how-to-use-game-events.md
@@ -0,0 +1,81 @@
+# How To Use Game Events
+
+This is a simple example that demonstrates how-to use the `game_event` and `game_event_creature` tables to trigger a repeating in-game event. This is a simple example, but it should be enough to give the reader a taste of what's required to start using in-game events.
+
+**Note:** please make a database backup before making any changes to your database, including the ones below. This is just incase you overwrite something or do make breaking changes.
+
+## Getting Started
+
+Below are some SQL changes that can be made to the \`acore_world\` database that will cause three "Defias Cutpurse" NPCs appear and disappear every two (2) minutes from Elwynn Forest. This is designed to be a simple example and doesn't represent an improvement to the game world in anyway.
+
+We're going to assume you're using the `mysql` commandline tool to manipulate the database, but you can use any tool you want that lets you run custom SQL queries.
+
+Login to the game world using the WoW client and start by teleporting to the area we intend on working in. Use the following GM command, which might require `.gm on` first: `.go xyz -9168.486 86.90783 77.05649 0 0.006`. You'll see three NPCs walking around a tent, like this:
+
+![NPCs Visible](assets/images/tutorials/game_event_example/npcs.png)
+
+Next, connect to the AzerothCore MySQL database and ensure you're using the correct table: \`use acore_world\`.
+
+Next, apply the following SQL to create a new event with ID 91 to your world (**note**: this will delete any existing event entry with an ID of 91):
+
+```sql
+DELETE FROM game_event WHERE eventEntry = 91;
+INSERT INTO game_event (
+	eventEntry,
+	start_time,
+	end_time,
+	occurence,
+	length,
+	holiday,
+	holidayStage,
+	description,
+	world_event,
+	announce
+) VALUES (
+	91,
+	"2000-01-01 14:00:00",
+	"2030-12-31 14:00:00",
+	2,
+	1,
+	0,
+	0,
+	"TESTING EVENT",
+	0,
+	1
+);
+```
+
+This triggers once every `occurence` minutes or `2` minutes in this case. The event will last for `length` minutes or `1` minute for us, which means after one (`1`) minute the NPCs will be added back into the game world.
+
+Now update the `game_event_creature` table by applying the following SQL:
+
+```sql
+DELETE FROM game_event_creature WHERE guid=79888;
+DELETE FROM game_event_creature WHERE guid=79889;
+DELETE FROM game_event_creature WHERE guid=79890;
+
+INSERT INTO game_event_creature (eventEntry,guid) VALUES (-91,79888);
+INSERT INTO game_event_creature (eventEntry,guid) VALUES (-91,79889);
+INSERT INTO game_event_creature (eventEntry,guid) VALUES (-91,79890);
+```
+
+This defines the specific NPCs GUIDs we want the game event to **despawn** _from_ the world for us. It doesn't spawn the creatures as they already exist. There are other `game_event_*` tables for managing other things too, much more complex things, but we're just selecting this table as it's an easy one to work with and use to demonstrate how events work. Note that we've set the `eventEntry` field to a **negative** value -- that is `-91` -- and not (positive) `91` because we want this event to **delete** the NPCs. Don't worry, when the event ends after `length` minutes, the NPCs will be respawned again. If you want the event to spawn creatures you've defined, then you'd a positive GUID.
+
+Finally restart your AzerothCore world server. Because the game world has been restarted, and you had to log back into the game, you will have missed the first run of the event and therefore the announcement (which is set to `1` in our example SQL, above.) This means depending on how fast you teleport to the coordinates above, you may find the NPCs are still there or may have been removed.
+
+When you hang around the area at the coordinates from above, you'll eventually see the NPCs despawn:
+
+![No NPCs Visible](assets/images/tutorials/game_event_example/no-npcs.png)
+
+## Undoing Everything
+
+If you want to now remove this event from your database, the following SQL can be used:
+
+```sql
+DELETE FROM game_event WHERE eventEntry = 91;
+DELETE FROM game_event_creature WHERE guid=79888;
+DELETE FROM game_event_creature WHERE guid=79889;
+DELETE FROM game_event_creature WHERE guid=79890;
+```
+
+You may need to reload AzerothCore's "World Server" for the changes above to take effect.