[wiki] Add tons of examples to every single function enum and struct in the lib

FreddyMSchubert · FreddyMSchubert · commit 16862f492b0b · 2025-10-07T08:34:51.000Z
diff --git a/wiki/README.md b/wiki/README.md
@@ -1,12 +1,4 @@
-# 🏠 The Art of CORE
-
-## 🤗 Welcome to the Official CORE Documentation 📚
-
-Read it carefully, there are many helpful tidbits hidden in here.
-
-Especially the [tips & tricks section](tips_and_tricks) down below and the tip boxes in the [Core Library Pages](core_library/README) can be incredibly helpful.
-
-Reading the documentation sucks, but it was handwritten to be as helpful as possible and is worth a skim. If there was a question that the documentation didn't answer, please let us know so we can tell you and improve the documentation.
+> 🤗 Welcome to the Official CORE Wiki, Documentation & Reference 📚
 
 # 👾 What is CORE?
 
@@ -20,10 +12,6 @@ You can receive gems by having your units attack the gem deposits on the map or
 
 # 🚀 Getting Started with Your Own CORE Bot
 
-To start building your own CORE bot, ensure you've completed the following prerequisites:
-
-### Prerequisites
-
 1. **Be a Registered CORE Participant/Team** ✨
 	- Visit our website, [COREGAME.de](https://coregame.de/), sign up, join the right event, and add your team members.
 
@@ -33,25 +21,17 @@ To start building your own CORE bot, ensure you've completed the following prere
 3. **Follow the README in the repository** 📧
 	- Basically, run `make devcontainer`, and then you can get started! Compile using `make`, visualizer to view the games is under `localhost:4000`, everything in `src/` will be compiled into your bot.
 
-🎉 **You are now ready to start coding!** 😎
-
 4. **Push some code!** 🔝
-	- The code you pushed will be used to execute games in the queue and in the final tournament. So make sure to push your code regularly and use to queue to test your bot against other participants!
-
-### 🔎 Get into Core Game!
-
-Look at all the different [Core Game Library Info Pages](core_library/README) in the sidebar to get sense of how things work! This wiki is your key to the trophy. 🏆
-
-### Play and test against other Teams 🎮
+	- The code you pushed will be used to execute games in the queue and in the final tournament. So make sure to push your code & test it against other players regularly!
 
-Once the default test bot is too boring and you always win, feel free to share your compiled bot with other teams and play against them. You can do this via the queue feature on the website or locally. Of course, you can't force them but it might benefit both of you to see your bots in _real_ action.
-
-# 🏆 To win the event
-
-> Don't overcomplicate things! Simple but well-balanced bots may often reign over overcomplicated but ineffective bots.
+🎉 **You are now ready to start coding!** 😎
 
-> Play against other players as often as possible!
+# 🏆 The Five Sacred Laws of Core Game Victory 👑
 
-> Have fun! Don't take things too seriously & be nice to each other. Embrace the good vibes in a friendly competition! ⚡️
+1. **Simplicity is Strength** - A simple, balanced bot will crush an overcomplicated mess. Build, test, refine — step by step, one small feature at a time.
+2. **Battle is the Best Teacher** - No plan survives first contact. Face off against others as often as possible; every loss is data, every win is progress.
+3. **Knowledge is power** - Master the documentation, understand every function you wield. A wise coder outplays a reckless but fast one every single time.
+4. **Unity is Might** - Team up if you can. Two brains debug faster than one, and strategy thrives on collaboration.
+5. **Have fun!** - Don't take things too seriously & be nice to each other. Embrace the good vibes in a friendly competition! ⚡️
 
-Good luck from the CORE team! 🚀🎸🔥💥🗿
+***Good luck*** **from the CORE team!** 🚀🎸🔥💥🗿
diff --git a/wiki/basics.md b/wiki/basics.md
@@ -1,6 +1,7 @@
 The game is set on a square grid filled with objects.
 - There can only ever be one object at one position, no more.
 - Each object has a unique, unchanging id.
+- The memory location of objects may change between ticks.
 
 There is a central server that stores the game state. Each bot sends packets back and forth with the server.\
 Once per tick each clients local game state is updated.
diff --git a/wiki/documentation/cooldowns.md b/wiki/documentation/cooldowns.md
@@ -22,3 +22,17 @@ e.g.:
 ## Core Spawn Cooldown
 
 The core spawn cooldown is more straightforward, after a new unit was spawned, it is simply reset to a static config-defined value.
+
+## Examples
+
+```c
+int ft_util_actionCooldown(t_obj *unit)
+{
+	t_unit_config *uconf = core_get_unitConfig(unit->s_unit.unit_type);
+	unsigned int gems = max(unit->s_unit.gems, 1);
+	unsigned int ac = uconf->baseActionCooldown + gems / uconf->balancePerCooldownStep;
+	if (ac > uconf->maxActionCooldown) ac = uconf->maxActionCooldown;
+	if (ac < 1) ac = 1;
+	return (ac);
+}
+```
diff --git a/wiki/documentation/playing_against_others.md b/wiki/documentation/playing_against_others.md
@@ -1 +1,22 @@
-// TODO
+## Playing against others locally
+
+Have the person you want to play against send them their executable. In their cloned git repo, it will be created under `my-core-bot/bot`.
+
+```bash
+/core/server /workspace/configs/server.config.json /workspace/configs/game.config.json /core/data 42 43 > /dev/null &
+./PATH_TO_PLAYER_1_EXECUTABLE 42 > /dev/null &
+./PATH_TO_PLAYER_2_EXECUTABLE 43
+```
+
+Running the following code will start a game of the player 1 executable against the player 2 executable.
+
+## Playing against others online
+
+Once you have pushed some code, you can compete on the website in the queue or tournament.
+
+The queue will pit random people that join the queue at a similar time against each other.\
+The tournament will at the end determine the winner of your event.
+
+Using the queue often is a great idea to see how good your bot is in what aspects of Core Game.
+
+If your code runs locally but not on the website, you may want to have a look at the [website setup guide](website_setup).
diff --git a/wiki/documentation/website_setup.md b/wiki/documentation/website_setup.md
@@ -2,8 +2,6 @@ This page is focused around making sure your bot can properly run on the website
 
 > Generally, you don't need to worry about going through this page, just test that your bot runs on the website once and you'll be fine. As long as you keep the folder name `my-core-bot` and not modify the `my-core-bot/Makefile`, your bot will run fine on the website. If your bot doesn't run on the website though, this is the page for you.
 
-> For more details read this. Website runs are stricter than local.
-
 # What the Website Expects
 
 - **Repository layout**: Your bot source must live at `my-core-bot/` at the repo root.
diff --git a/wiki/reference/config/function core_get_unitConfig(...).md b/wiki/reference/config/function core_get_unitConfig(...).md
@@ -22,4 +22,12 @@ t_unit_config *core_get_unitConfig(t_unit_type type);
 
 ## Examples
 
+```c
+t_unit_config *uconf = core_get_unitConfig(UNIT_MINER);
+if (ft_get_core_own()->s_core.gems >= uconf->cost)
+{
+	core_action_createUnit(UNIT_MINER);
+}
+```
+
 ## Related
diff --git a/wiki/reference/config/function core_print_config().md b/wiki/reference/config/function core_print_config().md
@@ -22,4 +22,15 @@ void
 
 ## Examples
 
+```c
+void ft_on_tick(unsigned long tick)
+{
+	if (tick == 0)
+	{
+		core_print_config();
+	}
+// ...
+```
+
+
 ## Related
diff --git a/wiki/reference/config/function core_print_config_game().md b/wiki/reference/config/function core_print_config_game().md
@@ -22,4 +22,14 @@ void
 
 ## Examples
 
+```c
+void ft_on_tick(unsigned long tick)
+{
+	if (tick == 0)
+	{
+		core_print_config_game();
+	}
+// ...
+```
+
 ## Related
diff --git a/wiki/reference/config/function core_print_config_unit(...).md b/wiki/reference/config/function core_print_config_unit(...).md
@@ -22,4 +22,13 @@ void
 
 ## Examples
 
+```c
+printf("Warrior Config: \n");
+core_print_config_unit(UNIT_WARRIOR);
+printf("Miner Config: \n");
+core_print_config_unit(UNIT_MINER);
+printf("Carrier Config: \n");
+core_print_config_unit(UNIT_CARRIER);
+```
+
 ## Related
diff --git a/wiki/reference/config/struct t_config.md b/wiki/reference/config/struct t_config.md
@@ -53,4 +53,13 @@ typedef struct s_config
 
 ## Examples
 
+```c
+void ft_on_tick(unsigned long tick)
+{
+	if (tick < game.config.idle_income_timeout)
+	{
+		// focus less on miner & carrier spawning
+		// ...
+```
+
 ## Related
diff --git a/wiki/reference/config/struct t_unit_config.md b/wiki/reference/config/struct t_unit_config.md
@@ -45,4 +45,12 @@ typedef struct s_unit_config
 
 ## Examples
 
+```c
+t_unit_config *uconf = core_get_unitConfig(UNIT_MINER);
+if (ft_get_core_own()->s_core.gems >= uconf->cost)
+{
+	core_action_createUnit(UNIT_MINER);
+}
+```
+
 ## Related
diff --git a/wiki/reference/getters/function core_get_obj_filter_first(...).md b/wiki/reference/getters/function core_get_obj_filter_first(...).md
@@ -24,4 +24,16 @@ t_obj *core_get_obj_filter_first(bool (*condition)(const t_obj *));
 
 ## Examples
 
+```c
+static bool is_core_own(const t_obj *obj)
+{
+	return (is_core(obj) && obj->s_core.team_id == game.my_team_id);
+}
+t_obj *ft_get_core_own(void)
+{
+	t_pos pos = {0, 0};
+	return core_get_obj_filter_first(pos, is_core_own);
+}
+```
+
 ## Related
diff --git a/wiki/reference/getters/function core_get_obj_filter_nearest(...).md b/wiki/reference/getters/function core_get_obj_filter_nearest(...).md
@@ -23,4 +23,17 @@ t_obj *core_get_obj_filter_nearest(t_pos pos, bool (*condition)(const t_obj *));
 
 ## Examples
 
+```c
+static bool is_deposit(const t_obj *obj)
+{
+	return (obj->type == OBJ_DEPOSIT);
+}
+t_obj *ft_get_deposit_nearest(t_pos pos)
+{
+	return core_get_obj_filter_nearest(pos, is_deposit);
+}
+// ...
+t_obj *nearest_deposit = ft_get_deposit_nearest(miner->pos);
+```
+
 ## Related
diff --git a/wiki/reference/getters/function core_get_obj_from_id(...).md b/wiki/reference/getters/function core_get_obj_from_id(...).md
@@ -22,4 +22,15 @@ t_obj *core_get_obj_from_id(unsigned long id);
 
 ## Examples
 
+```c
+// we only need one carrier for now
+int carrier_id = -1;
+
+void ft_on_tick(unsigned long tick)
+{
+	if (carrier_id >= 0)
+	{
+		t_obj *carrier = core_get_obj_by_id(carrier_id);
+```
+
 ## Related
diff --git a/wiki/reference/getters/function core_get_obj_from_pos(...).md b/wiki/reference/getters/function core_get_obj_from_pos(...).md
@@ -22,4 +22,11 @@ t_obj *core_get_obj_from_pos(t_pos pos);
 
 ## Examples
 
+```c
+bool ft_is_pos_empty(t_pos pos)
+{
+	return core_get_obj_from_pos(pos) == NULL;
+}
+```
+
 ## Related
diff --git a/wiki/reference/getters/function core_get_objs_filter(...).md b/wiki/reference/getters/function core_get_objs_filter(...).md
@@ -24,4 +24,13 @@ t_obj **core_get_objs_filter(bool (*condition)(const t_obj *));
 
 ## Examples
 
+```c
+t_obj **warriors = core_get_objs_filter(ft_is_warrior);
+for (int i = 0; warriors && warriors[i]; i++)
+{
+	// warrior move & attack logic
+}
+free(warriors);
+```
+
 ## Related
diff --git a/wiki/reference/getters/function core_get_objs_filter_count(...).md b/wiki/reference/getters/function core_get_objs_filter_count(...).md
@@ -22,4 +22,29 @@ unsigned int core_get_objs_filter_count(bool (*condition)(const t_obj *));
 
 ## Examples
 
+```c
+bool ft_is_warrior(const t_obj *obj)
+{
+	return (obj->type == OBJ_UNIT && obj->s_unit.unit_type == UNIT_WARRIOR);
+}
+// ...
+printf("Warrior Count: %d\n", core_get_objs_filter_count(ft_is_warrior));
+
+```
+
+```c
+int unitToCheck = 0;
+long unsigned int teamToCheck = 0;
+bool ft_get_count_of_unitToCheck(const t_obj *obj)
+{
+	return (obj->type == OBJ_UNIT && obj->state == STATE_ALIVE && (int)obj->s_unit.unit_type == unitToCheck && obj->s_unit.team_id == teamToCheck);
+}
+int get_unit_count(int unitType, int teamId)
+{
+	unitToCheck = unitType;
+	teamToCheck = teamId;
+	return (int)core_get_objs_filter_count(ft_get_count_of_unitToCheck);
+}
+```
+
 ## Related
diff --git a/wiki/reference/objects/enum e_build_type.md b/wiki/reference/objects/enum e_build_type.md
@@ -27,4 +27,10 @@ typedef enum e_build_type
 
 ## Examples
 
+```c
+// building logic
+if (core_get_unitConfig(obj->s_unit.unit_type)->build_type == BUILD_TYPE_NONE)
+	continue;
+```
+
 ## Related
diff --git a/wiki/reference/objects/enum e_obj_type.md b/wiki/reference/objects/enum e_obj_type.md
@@ -31,4 +31,19 @@ typedef enum e_obj_type
 
 ## Examples
 
+```c
+static bool is_deposit(const t_obj *obj)
+{
+	return (obj->type == OBJ_DEPOSIT);
+}
+static bool is_gems(const t_obj *obj)
+{
+	return (obj->type == OBJ_GEM_PILE);
+}
+static bool is_deposit_gems(const t_obj *obj)
+{
+	return (is_deposit(obj) || is_gems(obj));
+}
+```
+
 ## Related
diff --git a/wiki/reference/objects/struct t_obj.md b/wiki/reference/objects/struct t_obj.md
@@ -83,4 +83,25 @@ Walls don't have any special properties so they don't need a unionized struct, d
 
 ## Examples
 
+```c
+// move units
+t_obj **units = ft_get_units_own();
+for (int i = 0; units && units[i]; i++)
+{
+	t_obj *obj = units[i];
+
+	switch ((int)obj->s_unit.unit_type)
+	{
+	case UNIT_WARRIOR:
+		// ...
+		break;
+
+	case UNIT_MINER:
+		// ...
+		break;
+	}
+}
+free(units);
+```
+
 ## Related
diff --git a/wiki/reference/objects/struct t_pos.md b/wiki/reference/objects/struct t_pos.md
@@ -27,4 +27,17 @@ typedef struct s_pos
 
 ## Examples
 
+```c
+int manhattan_distance(t_pos pos1, t_pos pos2)
+{
+	double x = (double)pos1.x - (double)pos2.x;
+	double y = (double)pos1.y - (double)pos2.y;
+
+	if (x < 0) x = -x;
+	if (y < 0) y = -y;
+
+	return ((int)(x + y));
+}
+```
+
 ## Related
diff --git a/wiki/reference/objects/struct t_unit_type.md b/wiki/reference/objects/struct t_unit_type.md
diff --git a/wiki/reference/printing/function core_print_obj(...).md b/wiki/reference/printing/function core_print_obj(...).md
