├── README.md
├── ChunkManager.cs
└── LICENSE


/README.md:
--------------------------------------------------------------------------------
 1 | # ChunkManager for Godot
 2 | 
 3 | ## Overview
 4 | 
 5 | `ChunkManager` is a class designed for managing chunks of tiles in a 2D game using the Godot Engine. It dynamically loads and unloads chunks based on the player's position, utilizing noise generation to create varied terrain types such as water, sand, and grass. This class is particularly useful for games with large worlds where only a portion of the map needs to be rendered at any given time.
 6 | 
 7 | ## Features
 8 | 
 9 | - Dynamic chunk loading and unloading based on player position.
10 | - Terrain generation using noise functions.
11 | - Support for different tile types (e.g., water, sand, grass).
12 | - Efficient memory management by freeing unused chunks.
13 | 
14 | ## Installation
15 | 
16 | 1. Clone the repository or download the source code.
17 | 2. Place the `ChunkManager.cs` file in your Godot project under the appropriate directory (e.g., `Scripts/`).
18 | 
19 | ## Usage
20 | 
21 | To use the `ChunkManager`, follow these steps:
22 | 
23 | 1. Create a new scene in Godot.
24 | 2. Add a `Node2D` as the root node.
25 | 3. Attach the `ChunkManager` script to the root node.
26 | 4. Assign a `TileSet` to the `_tileSet` property in the Godot editor.
27 | 5. Call `RefreshChunks()` method to load chunks around the player's position.
28 | 
29 | ### Example
30 | 
31 | ```csharp
32 | public class Player : Node2D
33 | {
34 |     public override void _Process(float delta)
35 |     {
36 |         // Update player position
37 |         Vector2 position = this.Position;
38 | 
39 |         // Refresh chunks based on player position
40 |         ChunkManager.Instance.RefreshChunks(position);
41 |     }
42 | }
43 | 


--------------------------------------------------------------------------------
/ChunkManager.cs:
--------------------------------------------------------------------------------
  1 | using Godot;
  2 | using System;
  3 | using System.Collections.Generic;
  4 | using System.Linq;
  5 | 
  6 | /// <summary>
  7 | /// Manages the generation and loading of chunks in a tile-based game world.
  8 | /// </summary>
  9 | public partial class ChunkManager : Node2D
 10 | {
 11 |     /// <summary>
 12 |     /// The instance of the ChunkManager.
 13 |     /// </summary>
 14 |     protected static ChunkManager _instance;
 15 | 
 16 |     /// <summary>
 17 |     /// Gets the instance of the ChunkManager.
 18 |     /// </summary>
 19 |     public static ChunkManager Instance
 20 |     {
 21 |         get
 22 |         {
 23 |             if (_instance == null)
 24 |             {
 25 |                 _instance = new ChunkManager();
 26 |             }
 27 |             return _instance;
 28 |         }
 29 |     }
 30 | 
 31 |     /// <summary>
 32 |     /// Initializes a new instance of the ChunkManager class.
 33 |     /// </summary>
 34 |     public ChunkManager()
 35 |     {
 36 |         _instance = this;
 37 |     }
 38 | 
 39 |     /// <summary>
 40 |     /// The tile set used for rendering the chunks.
 41 |     /// </summary>
 42 |     [Export]
 43 |     private TileSet _tileSet { get; set; }
 44 | 
 45 |     /// <summary>
 46 |     /// The size of each chunk in tiles.
 47 |     /// </summary>
 48 |     private Vector2 _chunkSize;
 49 | 
 50 |     /// <summary>
 51 |     /// The number of chunks to buffer around the player's position.
 52 |     /// </summary>
 53 |     private int _chunkBuffer = 2;
 54 | 
 55 |     /// <summary>
 56 |     /// The dictionary of loaded chunks, indexed by their position.
 57 |     /// </summary>
 58 |     private Dictionary<Vector2, TileMapLayer> _loadedChunks = new Dictionary<Vector2, TileMapLayer>();
 59 | 
 60 |     /// <summary>
 61 |     /// The noise generator used for generating tile values.
 62 |     /// </summary>
 63 |     private FastNoiseLite _noise = new FastNoiseLite();
 64 | 
 65 |     /// <summary>
 66 |     /// Indicates whether the mouse button is being held.
 67 |     /// </summary>
 68 |     private bool HoldingMouse = false;
 69 | 
 70 |     /// <summary>
 71 |     /// The list of noise values generated for each tile.
 72 |     /// </summary>
 73 |     private List<float> _noiseValues = new List<float>();
 74 | 
 75 |     /// <summary>
 76 |     /// The position of the chunk currently being hovered over by the mouse.
 77 |     /// </summary>
 78 |     private Vector2 _hoverChunk;
 79 | 
 80 |     /// <summary>
 81 |     /// Called when the node is ready to be used.
 82 |     /// </summary>
 83 |     public override void _Ready()
 84 |     {
 85 |         _noise.Seed = new Random().Next(-1000000, 1000000);
 86 |         _noise.Frequency = 0.01f;
 87 |         _chunkSize = new Vector2(32, 32);
 88 |         LoadChunksAroundPosition(Vector2.Zero);
 89 |     }
 90 | 
 91 |     /// <summary>
 92 |     /// Refreshes the loaded chunks based on the current camera position.
 93 |     /// </summary>
 94 |     /// <param name="pos">The position to refresh the chunks around.</param>
 95 |     public void RefreshChunks(Vector2 pos)
 96 |     {
 97 |         LoadChunksAroundPosition(pos);
 98 |         UnloadChunksOutsidePosition(pos);
 99 |     }
100 | 
101 |     /// <summary>
102 |     /// Loads the chunks around the specified position.
103 |     /// </summary>
104 |     /// <param name="position">The position to load the chunks around.</param>
105 |     private void LoadChunksAroundPosition(Vector2 position)
106 |     {
107 |         for (int x = -_chunkBuffer; x <= _chunkBuffer; x++)
108 |         {
109 |             for (int y = -_chunkBuffer; y <= _chunkBuffer; y++)
110 |             {
111 |                 Vector2 chunkPosition = GetChunkPosition(position) + new Vector2(x, y);
112 |                 if (!_loadedChunks.ContainsKey(chunkPosition))
113 |                 {
114 |                     TileMapLayer chunk = new TileMapLayer();
115 |                     chunk.Name = $"Chunk_{chunkPosition.X}_{chunkPosition.Y}";
116 |                     chunk.TileSet = _tileSet;
117 |                     chunk.TileSet.TileSize = _tileSet.TileSize;
118 |                     chunk.Position = chunkPosition * _chunkSize * _tileSet.TileSize;
119 |                     this.AddChild(chunk);
120 |                     _loadedChunks.Add(chunkPosition, chunk);
121 |                 }
122 |             }
123 |         }
124 | 
125 |         // Generate noise for each tile in the loaded chunks
126 |         foreach (KeyValuePair<Vector2, TileMapLayer> chunk in _loadedChunks)
127 |         {
128 |             Vector2 chunkPosition = chunk.Key;
129 |             TileMapLayer chunkLayer = chunk.Value;
130 |             for (int x = 0; x < _chunkSize.X; x++)
131 |             {
132 |                 for (int y = 0; y < _chunkSize.Y; y++)
133 |                 {
134 |                     Vector2 tilePosition = chunkPosition * _chunkSize + new Vector2(x, y);
135 |                     float tileValue = _noise.GetNoise2D(tilePosition.X, tilePosition.Y);
136 | 
137 |                     if (tileValue < -0.25)
138 |                     {
139 |                         chunkLayer.SetCell(new Vector2I(x, y), 0, new Vector2I(3, 1), 0);
140 |                     }
141 |                     else if (tileValue < -0.1)
142 |                     {
143 |                         chunkLayer.SetCell(new Vector2I(x, y), 0, new Vector2I(3, 0), 0);
144 |                     }
145 |                     else if (tileValue < 0.0 && tileValue >= -0.1)
146 |                     {
147 |                         chunkLayer.SetCell(new Vector2I(x, y), 0, new Vector2I(1, 0), 0);
148 |                     }
149 |                     else
150 |                     {
151 |                         chunkLayer.SetCell(new Vector2I(x, y), 0, new Vector2I(0, 0), 0);
152 |                     }
153 |                 }
154 |             }
155 |         }
156 |     }
157 | 
158 |     /// <summary>
159 |     /// Unloads the chunks that are outside the specified position.
160 |     /// </summary>
161 |     /// <param name="position">The position to check against.</param>
162 |     private void UnloadChunksOutsidePosition(Vector2 position)
163 |     {
164 |         List<Vector2> chunksToRemove = new List<Vector2>();
165 | 
166 |         foreach (KeyValuePair<Vector2, TileMapLayer> chunk in _loadedChunks)
167 |         {
168 |             if (!IsPositionHasAroundChunk(position, chunk.Key))
169 |             {
170 |                 chunksToRemove.Add(chunk.Key);
171 |                 this.RemoveChild(chunk.Value);
172 |                 chunk.Value.QueueFree();
173 |             }
174 |         }
175 | 
176 |         foreach (Vector2 chunkPosition in chunksToRemove)
177 |         {
178 |             _loadedChunks.Remove(chunkPosition);
179 |         }
180 |     }
181 | 
182 |     /// <summary>
183 |     /// Gets the chunk position for the specified position.
184 |     /// </summary>
185 |     /// <param name="position">The position to get the chunk position for.</param>
186 |     /// <returns>The chunk position.</returns>
187 |     public Vector2 GetChunkPosition(Vector2 position)
188 |     {
189 |         return new Vector2(Mathf.FloorToInt(position.X / (_chunkSize.X * _tileSet.TileSize.X)), Mathf.FloorToInt(position.Y / (_chunkSize.Y * _tileSet.TileSize.Y)));
190 |     }
191 | 
192 |     /// <summary>
193 |     /// Checks if the specified position has a chunk around it.
194 |     /// </summary>
195 |     /// <param name="position">The position to check.</param>
196 |     /// <param name="chunkPosition">The chunk position to check against.</param>
197 |     /// <returns>True if the position has a chunk around it, false otherwise.</returns>
198 |     private bool IsPositionHasAroundChunk(Vector2 position, Vector2 chunkPosition)
199 |     {
200 |         for (int x = -_chunkBuffer; x <= _chunkBuffer; x++)
201 |         {
202 |             for (int y = -_chunkBuffer; y <= _chunkBuffer; y++)
203 |             {
204 |                 Vector2 chunk = chunkPosition + new Vector2(x, y);
205 |                 Vector2 chunkWorldPosition = chunk * _chunkSize * _tileSet.TileSize;
206 |                 Rect2 chunkBounds = new Rect2(chunkWorldPosition, _chunkSize * _tileSet.TileSize);
207 |                 if (chunkBounds.HasPoint(position))
208 |                 {
209 |                     return true;
210 |                 }
211 |             }
212 |         }
213 |         return false;
214 |     }
215 | 
216 |     /// <summary>
217 |     /// Checks if the specified position is inside the specified chunk.
218 |     /// </summary>
219 |     /// <param name="position">The position to check.</param>
220 |     /// <param name="chunkPosition">The chunk position to check against.</param>
221 |     /// <returns>True if the position is inside the chunk, false otherwise.</returns>
222 |     public bool IsPositionInsideChunk(Vector2 position, Vector2 chunkPosition)
223 |     {
224 |         Vector2 chunkWorldPosition = chunkPosition * _chunkSize * _tileSet.TileSize;
225 |         Rect2 chunkBounds = new Rect2(chunkWorldPosition, _chunkSize * _tileSet.TileSize);
226 |         return chunkBounds.HasPoint(position);
227 |     }
228 | 
229 |     /// <summary>
230 |     /// Gets the tile position for the specified position.
231 |     /// </summary>
232 |     /// <param name="position">The position to get the tile position for.</param>
233 |     /// <returns>The tile position.</returns>
234 |     public Vector2I GetTilePosition(Vector2 position)
235 |     {
236 |         Vector2 chunkPosition = GetChunkPosition(position);
237 |         Vector2 chunkWorldPosition = chunkPosition * _chunkSize * _tileSet.TileSize;
238 |         Vector2 localPosition = position - chunkWorldPosition;
239 |         return new Vector2I((int)(localPosition.X / _tileSet.TileSize.X), (int)(localPosition.Y / _tileSet.TileSize.Y));
240 |     }
241 | 
242 |     /// <summary>
243 |     /// Gets the world position of the specified tile in the specified chunk.
244 |     /// </summary>
245 |     /// <param name="position">The position of the tile in the chunk.</param>
246 |     /// <param name="chunkPosition">The position of the chunk.</param>
247 |     /// <returns>The world position of the tile.</returns>
248 |     public Vector2 GetTileWorldPosition(Vector2 position, Vector2 chunkPosition)
249 |     {
250 |         Vector2 chunkWorldPosition = chunkPosition * _chunkSize * _tileSet.TileSize;
251 |         return chunkWorldPosition + new Vector2(position.X * _tileSet.TileSize.X, position.Y * _tileSet.TileSize.Y);
252 |     }
253 | }
254 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 |                                  Apache License
  2 |                            Version 2.0, January 2004
  3 |                         http://www.apache.org/licenses/
  4 | 
  5 |    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
  6 | 
  7 |    1. Definitions.
  8 | 
  9 |       "License" shall mean the terms and conditions for use, reproduction,
 10 |       and distribution as defined by Sections 1 through 9 of this document.
 11 | 
 12 |       "Licensor" shall mean the copyright owner or entity authorized by
 13 |       the copyright owner that is granting the License.
 14 | 
 15 |       "Legal Entity" shall mean the union of the acting entity and all
 16 |       other entities that control, are controlled by, or are under common
 17 |       control with that entity. For the purposes of this definition,
 18 |       "control" means (i) the power, direct or indirect, to cause the
 19 |       direction or management of such entity, whether by contract or
 20 |       otherwise, or (ii) ownership of fifty percent (50%) or more of the
 21 |       outstanding shares, or (iii) beneficial ownership of such entity.
 22 | 
 23 |       "You" (or "Your") shall mean an individual or Legal Entity
 24 |       exercising permissions granted by this License.
 25 | 
 26 |       "Source" form shall mean the preferred form for making modifications,
 27 |       including but not limited to software source code, documentation
 28 |       source, and configuration files.
 29 | 
 30 |       "Object" form shall mean any form resulting from mechanical
 31 |       transformation or translation of a Source form, including but
 32 |       not limited to compiled object code, generated documentation,
 33 |       and conversions to other media types.
 34 | 
 35 |       "Work" shall mean the work of authorship, whether in Source or
 36 |       Object form, made available under the License, as indicated by a
 37 |       copyright notice that is included in or attached to the work
 38 |       (an example is provided in the Appendix below).
 39 | 
 40 |       "Derivative Works" shall mean any work, whether in Source or Object
 41 |       form, that is based on (or derived from) the Work and for which the
 42 |       editorial revisions, annotations, elaborations, or other modifications
 43 |       represent, as a whole, an original work of authorship. For the purposes
 44 |       of this License, Derivative Works shall not include works that remain
 45 |       separable from, or merely link (or bind by name) to the interfaces of,
 46 |       the Work and Derivative Works thereof.
 47 | 
 48 |       "Contribution" shall mean any work of authorship, including
 49 |       the original version of the Work and any modifications or additions
 50 |       to that Work or Derivative Works thereof, that is intentionally
 51 |       submitted to Licensor for inclusion in the Work by the copyright owner
 52 |       or by an individual or Legal Entity authorized to submit on behalf of
 53 |       the copyright owner. For the purposes of this definition, "submitted"
 54 |       means any form of electronic, verbal, or written communication sent
 55 |       to the Licensor or its representatives, including but not limited to
 56 |       communication on electronic mailing lists, source code control systems,
 57 |       and issue tracking systems that are managed by, or on behalf of, the
 58 |       Licensor for the purpose of discussing and improving the Work, but
 59 |       excluding communication that is conspicuously marked or otherwise
 60 |       designated in writing by the copyright owner as "Not a Contribution."
 61 | 
 62 |       "Contributor" shall mean Licensor and any individual or Legal Entity
 63 |       on behalf of whom a Contribution has been received by Licensor and
 64 |       subsequently incorporated within the Work.
 65 | 
 66 |    2. Grant of Copyright License. Subject to the terms and conditions of
 67 |       this License, each Contributor hereby grants to You a perpetual,
 68 |       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 69 |       copyright license to reproduce, prepare Derivative Works of,
 70 |       publicly display, publicly perform, sublicense, and distribute the
 71 |       Work and such Derivative Works in Source or Object form.
 72 | 
 73 |    3. Grant of Patent License. Subject to the terms and conditions of
 74 |       this License, each Contributor hereby grants to You a perpetual,
 75 |       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 76 |       (except as stated in this section) patent license to make, have made,
 77 |       use, offer to sell, sell, import, and otherwise transfer the Work,
 78 |       where such license applies only to those patent claims licensable
 79 |       by such Contributor that are necessarily infringed by their
 80 |       Contribution(s) alone or by combination of their Contribution(s)
 81 |       with the Work to which such Contribution(s) was submitted. If You
 82 |       institute patent litigation against any entity (including a
 83 |       cross-claim or counterclaim in a lawsuit) alleging that the Work
 84 |       or a Contribution incorporated within the Work constitutes direct
 85 |       or contributory patent infringement, then any patent licenses
 86 |       granted to You under this License for that Work shall terminate
 87 |       as of the date such litigation is filed.
 88 | 
 89 |    4. Redistribution. You may reproduce and distribute copies of the
 90 |       Work or Derivative Works thereof in any medium, with or without
 91 |       modifications, and in Source or Object form, provided that You
 92 |       meet the following conditions:
 93 | 
 94 |       (a) You must give any other recipients of the Work or
 95 |           Derivative Works a copy of this License; and
 96 | 
 97 |       (b) You must cause any modified files to carry prominent notices
 98 |           stating that You changed the files; and
 99 | 
100 |       (c) You must retain, in the Source form of any Derivative Works
101 |           that You distribute, all copyright, patent, trademark, and
102 |           attribution notices from the Source form of the Work,
103 |           excluding those notices that do not pertain to any part of
104 |           the Derivative Works; and
105 | 
106 |       (d) If the Work includes a "NOTICE" text file as part of its
107 |           distribution, then any Derivative Works that You distribute must
108 |           include a readable copy of the attribution notices contained
109 |           within such NOTICE file, excluding those notices that do not
110 |           pertain to any part of the Derivative Works, in at least one
111 |           of the following places: within a NOTICE text file distributed
112 |           as part of the Derivative Works; within the Source form or
113 |           documentation, if provided along with the Derivative Works; or,
114 |           within a display generated by the Derivative Works, if and
115 |           wherever such third-party notices normally appear. The contents
116 |           of the NOTICE file are for informational purposes only and
117 |           do not modify the License. You may add Your own attribution
118 |           notices within Derivative Works that You distribute, alongside
119 |           or as an addendum to the NOTICE text from the Work, provided
120 |           that such additional attribution notices cannot be construed
121 |           as modifying the License.
122 | 
123 |       You may add Your own copyright statement to Your modifications and
124 |       may provide additional or different license terms and conditions
125 |       for use, reproduction, or distribution of Your modifications, or
126 |       for any such Derivative Works as a whole, provided Your use,
127 |       reproduction, and distribution of the Work otherwise complies with
128 |       the conditions stated in this License.
129 | 
130 |    5. Submission of Contributions. Unless You explicitly state otherwise,
131 |       any Contribution intentionally submitted for inclusion in the Work
132 |       by You to the Licensor shall be under the terms and conditions of
133 |       this License, without any additional terms or conditions.
134 |       Notwithstanding the above, nothing herein shall supersede or modify
135 |       the terms of any separate license agreement you may have executed
136 |       with Licensor regarding such Contributions.
137 | 
138 |    6. Trademarks. This License does not grant permission to use the trade
139 |       names, trademarks, service marks, or product names of the Licensor,
140 |       except as required for reasonable and customary use in describing the
141 |       origin of the Work and reproducing the content of the NOTICE file.
142 | 
143 |    7. Disclaimer of Warranty. Unless required by applicable law or
144 |       agreed to in writing, Licensor provides the Work (and each
145 |       Contributor provides its Contributions) on an "AS IS" BASIS,
146 |       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 |       implied, including, without limitation, any warranties or conditions
148 |       of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 |       PARTICULAR PURPOSE. You are solely responsible for determining the
150 |       appropriateness of using or redistributing the Work and assume any
151 |       risks associated with Your exercise of permissions under this License.
152 | 
153 |    8. Limitation of Liability. In no event and under no legal theory,
154 |       whether in tort (including negligence), contract, or otherwise,
155 |       unless required by applicable law (such as deliberate and grossly
156 |       negligent acts) or agreed to in writing, shall any Contributor be
157 |       liable to You for damages, including any direct, indirect, special,
158 |       incidental, or consequential damages of any character arising as a
159 |       result of this License or out of the use or inability to use the
160 |       Work (including but not limited to damages for loss of goodwill,
161 |       work stoppage, computer failure or malfunction, or any and all
162 |       other commercial damages or losses), even if such Contributor
163 |       has been advised of the possibility of such damages.
164 | 
165 |    9. Accepting Warranty or Additional Liability. While redistributing
166 |       the Work or Derivative Works thereof, You may choose to offer,
167 |       and charge a fee for, acceptance of support, warranty, indemnity,
168 |       or other liability obligations and/or rights consistent with this
169 |       License. However, in accepting such obligations, You may act only
170 |       on Your own behalf and on Your sole responsibility, not on behalf
171 |       of any other Contributor, and only if You agree to indemnify,
172 |       defend, and hold each Contributor harmless for any liability
173 |       incurred by, or claims asserted against, such Contributor by reason
174 |       of your accepting any such warranty or additional liability.
175 | 
176 |    END OF TERMS AND CONDITIONS
177 | 
178 |    APPENDIX: How to apply the Apache License to your work.
179 | 
180 |       To apply the Apache License to your work, attach the following
181 |       boilerplate notice, with the fields enclosed by brackets "[]"
182 |       replaced with your own identifying information. (Don't include
183 |       the brackets!)  The text should be enclosed in the appropriate
184 |       comment syntax for the file format. We also recommend that a
185 |       file or class name and description of purpose be included on the
186 |       same "printed page" as the copyright notice for easier
187 |       identification within third-party archives.
188 | 
189 |    Copyright [yyyy] [name of copyright owner]
190 | 
191 |    Licensed under the Apache License, Version 2.0 (the "License");
192 |    you may not use this file except in compliance with the License.
193 |    You may obtain a copy of the License at
194 | 
195 |        http://www.apache.org/licenses/LICENSE-2.0
196 | 
197 |    Unless required by applicable law or agreed to in writing, software
198 |    distributed under the License is distributed on an "AS IS" BASIS,
199 |    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 |    See the License for the specific language governing permissions and
201 |    limitations under the License.
202 | 


--------------------------------------------------------------------------------