Updates

Author: essial

.editorconfig

@@ -0,0 +1,10 @@
+root = true
+[*]
+
+indent_size = 4
+indent_style = space
+tab_width = 4
+end_of_line = lf
+insert_final_newline = tue
+trim_trailing_whitespace = true
+max_line_length = 120

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Timothy Sarbin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,5 +1,25 @@
 # Abyss Engine
 
+Abyss Engine clean-room reimplementation of **Diablo 2**, written in C.
+The goal is to recreate the original game engine, but on a portable platform that can also easily be modded and
+extended.
+
+This is **not** a reverse-engineering project, and no original code from the game is used. It will also not be
+compaible with the original game's save files or multiplayer systems.
+
+Before running the engine, make sure it is [configured](#configuration) properly.
+
+You can hang out with the developers and other community members on `#AbyssEngine` at `irc.libera.chat`.
+We no longer maintain a Discord presence. Any such servers are not affiliated with this project.
+
+## Supported Platforms
+
+* Windows 10+ (x64, Arm64)
+* macOS (Arm64)
+* Linux (x64, Arm64)
+
+Other platforms may work, but are not officially supported.
+
 ## Building
 
 ### Prerequisites
@@ -15,6 +35,24 @@ git submodule update --init --recursive
 
 ### Compiling
 
+#### Visual Studio 2022 / Clion / VSCode (with CMake Tools extensions)
+
+Open the root project folder in the IDE and build the solution.
+
+#### XCode
+
+Generate an XCode project with cmake:
+
+```bash
+mkdir build
+cd build
+cmake .. -G Xcode
+```
+
+Then load the generated Xcode project and build it.
+
+#### Command Line
+
 ```bash
 mkdir build
 cd build
@@ -27,6 +65,9 @@ On **Linux** and **Windows**, you can run the engine by executing the `abyss` ex
 
 For **macOS**, you can run the engine by executing the `Abyss Engine.app` bundle in the build directory.
 
+Please note that the engine requires the `abyss.ini` configuration file. If you haven't set it,
+please refer to the [Configuration](#configuration) section below.
+
 ### Output Logs
 
 If you run AbyssEngine from the command line, it will output logs to the console.
@@ -39,6 +80,18 @@ of the app bundle on the command line:
 
 ## Configuration
 
+### MPQ files
+
+This engine requires the original Diablo 2+LOD MPQ files to run. These files are not included in the repository.
+You can legally obtain them by purchasing a physical copy of the game, or from a digital distribution platform
+such as battle.net.
+
+There are a lot of pirated versions of the game available online, but we do not condone piracy, and most of them
+are modded in a way that is not supported by the engine. Please don't waste developer resources by reporting issues
+while using pirated versions of the game.
+
+### abyss.ini
+
 In order for Abyss Engine to run, it needs to load abyss.ini. A template of this file is located at
 `/content/abyss.ini` in the source repo, and should be placed in the local settings folder for abyss
 based on the platform:

src/abyss.c

@@ -22,6 +22,8 @@ int main(int argc, char **argv) {
 
     LOG_DEBUG("Loading configuration...");
     char *config_path = malloc(4096);
+    FAIL_IF_NULL(config_path);
+
     memset(config_path, 0, 4096);
 #ifdef _WIN32
     snprintf(config_path, 4096, "%s\\abyss\\abyss.ini", getenv("APPDATA"));
@@ -37,10 +39,10 @@ int main(int argc, char **argv) {
     fileman_init();
 
     LOG_DEBUG("Creating window...");
-    sdl_window =
-        SDL_CreateWindow("Abyss Engine", SDL_WINDOWPOS_CENTERED, SDL_WINDOWPOS_CENTERED,
-                         (int)((float)800 * config->graphics.initial_scale),
-                         (int)((float)600 * config->graphics.initial_scale), SDL_WINDOW_SHOWN | SDL_WINDOW_RESIZABLE);
+    sdl_window = SDL_CreateWindow("Abyss Engine", SDL_WINDOWPOS_CENTERED, SDL_WINDOWPOS_CENTERED,
+                                  (int)((float)800 * config->graphics.initial_scale),
+                                  (int)((float)600 * config->graphics.initial_scale),
+                                  SDL_WINDOW_SHOWN | SDL_WINDOW_RESIZABLE | SDL_WINDOW_ALLOW_HIGHDPI);
 
     if (sdl_window == NULL) {
         FATAL(SDL_GetError());
@@ -77,11 +79,36 @@ int main(int argc, char **argv) {
             switch (sdl_event.type) {
             case SDL_QUIT:
                 running = false;
-                break;
+                continue;
             case SDL_MOUSEMOTION:
                 mouse_x = sdl_event.motion.x;
                 mouse_y = sdl_event.motion.y;
-                break;
+                continue;
+            case SDL_KEYDOWN:
+                if (sdl_event.key.keysym.sym == SDLK_F4 && sdl_event.key.keysym.mod == KMOD_LALT) {
+                    running = false;
+                }
+                if (sdl_event.key.keysym.sym == SDLK_RETURN &&
+                    (sdl_event.key.keysym.mod == KMOD_LALT || sdl_event.key.keysym.mod == KMOD_RALT)) {
+                    SDL_SetWindowFullscreen(sdl_window,
+                                            config->graphics.fullscreen ? 0 : SDL_WINDOW_FULLSCREEN_DESKTOP);
+                    config->graphics.fullscreen = !config->graphics.fullscreen;
+                }
+                // if in text input, handle backspace
+                if (strlen(text_input) > 0 && sdl_event.key.keysym.sym == SDLK_BACKSPACE) {
+                    text_input[strlen(text_input) - 1] = '\0';
+                }
+                key_pressed[sdl_event.key.keysym.scancode] = true;
+
+                continue;
+            case SDL_KEYUP:
+                key_pressed[sdl_event.key.keysym.scancode] = false;
+                continue;
+            case SDL_TEXTINPUT:
+                if (strlen(text_input) + strlen(sdl_event.text.text) < MAX_TEXT_INPUT_LENGTH) {
+                    strcat(text_input, sdl_event.text.text);
+                }
+                continue;
             }
         }
 

src/common/config.c

@@ -24,6 +24,7 @@ static const char *default_mpqs[] = {"d2exp.mpq",  "d2xmusic.mpq", "d2xtalk.mpq"
         free(X);                                                                                                       \
     }                                                                                                                  \
     (X) = malloc(sizeof(char) * (strlen(Y) + 1));                                                                      \
+    FAIL_IF_NULL(X);                                                                                                   \
     memset(X, 0, sizeof(char) * (strlen(Y) + 1));                                                                      \
     strcat(X, Y);
 
@@ -207,6 +208,8 @@ void config_set(char *category, char *key, char *value) {
 
 void config_load(const char *file_path) {
     config = malloc(sizeof(config_t));
+    FAIL_IF_NULL(config);
+
     memset(config, 0, sizeof(config_t));
     config->mpqs     = calloc(0, sizeof(char *));
     config->num_mpqs = 0;
@@ -218,6 +221,11 @@ void config_load(const char *file_path) {
     char *value    = malloc(sizeof(char) * MAX_LINE_LEN);
     char *line     = malloc(sizeof(char) * MAX_LINE_LEN);
 
+    FAIL_IF_NULL(category);
+    FAIL_IF_NULL(key);
+    FAIL_IF_NULL(value);
+    FAIL_IF_NULL(line);
+
     memset(category, 0, sizeof(char) * MAX_LINE_LEN);
     memset(key, 0, sizeof(char) * MAX_LINE_LEN);
     memset(value, 0, sizeof(char) * MAX_LINE_LEN);
@@ -286,20 +294,22 @@ void config_free() {
 
 void config_add_mpq(const char *mpq_file) {
     config->num_mpqs++;
-    config->mpqs = realloc(config->mpqs, config->num_mpqs * sizeof(char *));
 
-    if (config->mpqs == NULL) {
-        LOG_FATAL("Could not allocate memory for MPQs!");
-    }
+    config->mpqs = realloc(config->mpqs, config->num_mpqs * sizeof(char *));
+    FAIL_IF_NULL(config->mpqs);
 
     config->mpqs[config->num_mpqs - 1] = malloc(sizeof(char) * MAX_LINE_LEN);
+    FAIL_IF_NULL(config->mpqs[config->num_mpqs - 1]);
+
     memset(config->mpqs[config->num_mpqs - 1], 0, sizeof(char) * MAX_LINE_LEN);
     strcat(config->mpqs[config->num_mpqs - 1], config->base_path);
     strcat(config->mpqs[config->num_mpqs - 1], mpq_file);
 }
 
 void config_set_sane_defaults() {
     char *base_path = malloc(sizeof(char) * 4096);
+    FAIL_IF_NULL(base_path);
+
     memset(base_path, 0, sizeof(char) * 4096);
     getcwd(base_path, 4096);
     SET_PARAM_STR(config->base_path, base_path);

src/common/fileman.c

@@ -29,7 +29,10 @@ char *fix_path(const char *path) {
 
 void fileman_init() {
     fileman = malloc(sizeof(fileman_t));
+    FAIL_IF_NULL(fileman);
+
     memset(fileman, 0, sizeof(fileman_t));
+
     fileman->mpqs  = calloc(0, sizeof(mpq_t *));
     fileman->files = calloc(0, sizeof(fileman_file_entry_t));
 

src/common/globals.c

@@ -1,7 +1,21 @@
 #include "globals.h"
 
-SDL_Window   *sdl_window   = NULL;
-SDL_Renderer *sdl_renderer = NULL;
-bool          running      = false;
-int           mouse_x      = 0;
-int           mouse_y      = 0;
+SDL_Window   *sdl_window                            = NULL;
+SDL_Renderer *sdl_renderer                          = NULL;
+bool          running                               = false;
+int           mouse_x                               = 0;
+int           mouse_y                               = 0;
+bool          key_pressed[SDL_NUM_SCANCODES]        = {0};
+char          text_input[MAX_TEXT_INPUT_LENGTH + 1] = {0};
+
+void start_text_input() {
+    memset(text_input, 0, sizeof(text_input));
+    SDL_StartTextInput();
+}
+
+void stop_text_input() {
+    memset(text_input, 0, sizeof(text_input));
+    SDL_StopTextInput();
+}
+
+bool is_in_text_input() { return SDL_IsTextInputActive(); }

src/common/globals.h

@@ -1,18 +1,26 @@
 #ifndef ABYSS_GLOBALS_H
 #define ABYSS_GLOBALS_H
 
-#include <SDL2/SDL.h>
 #include "resource_paths.h"
+#include <SDL2/SDL.h>
 #include <stdbool.h>
 
 #define FATAL(MSG)                                                                                                     \
     SDL_ShowSimpleMessageBox(SDL_MESSAGEBOX_ERROR, "Fatal Error", MSG, sdl_window);                                    \
     exit(-1);
 
+#define MAX_TEXT_INPUT_LENGTH 100
+
 extern SDL_Window   *sdl_window;
 extern SDL_Renderer *sdl_renderer;
 extern bool          running;
 extern int           mouse_x;
 extern int           mouse_y;
+extern bool          key_pressed[SDL_NUM_SCANCODES];
+extern char          text_input[MAX_TEXT_INPUT_LENGTH + 1];
+
+void start_text_input();
+void stop_text_input();
+bool is_in_text_input();
 
 #endif // ABYSS_GLOBALS_H

src/common/log.c

@@ -3,14 +3,19 @@
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
+#ifdef _WIN32
+#include <Windows.h>
+#endif // _WIN32
 
+#define MAX_LOG_LINE_LENGTH 4096
 log_level_t log_level = LOG_LEVEL_ERROR;
 
 static const char *log_level_strings[] = {"", "DEBUG", "INFO ", "WARN ", "ERROR", "FATAL"};
 
 void log_set_level(const log_level_t level) { log_level = level; }
 
 void log_message(log_level_t level, const char *file, int line, const char *format, ...) {
+    char    msg[MAX_LOG_LINE_LENGTH];
     va_list args;
 
     if (level < log_level) {
@@ -19,23 +24,30 @@ void log_message(log_level_t level, const char *file, int line, const char *form
 
 #ifdef _WIN32
     printf("[%s] %s:%i - ", log_level_strings[level], strrchr(file, '\\') + 1, line);
+    if (IsDebuggerPresent()) {
+        memset(msg, 0, sizeof(char) * MAX_LOG_LINE_LENGTH);
+        snprintf(msg, MAX_LOG_LINE_LENGTH, "%s(%i): [%s] ", file, line, log_level_strings[level]);
+        va_start(args, format);
+        const int len = strchr(msg, '\0') - msg;
+        vsnprintf(strchr(msg, '\0'), len, format, args);
+        va_end(args);
+        strcat(msg, "\n");
+        OutputDebugString(msg);
+    }
 #else
     printf("[%s] %s:%i - ", log_level_strings[level], strrchr(file, '/') + 1, line);
 #endif
     va_start(args, format);
     vprintf(format, args);
     va_end(args);
-
     printf("\n");
 
     if (level == LOG_LEVEL_FATAL) {
-        char *msg = malloc(sizeof(char) * 10000);
-        memset(msg, 0, sizeof(char) * 10000);
+        memset(msg, 0, sizeof(char) * MAX_LOG_LINE_LENGTH);
         va_start(args, format);
-        vsnprintf(msg, 10000, format, args);
+        vsnprintf(msg, MAX_LOG_LINE_LENGTH, format, args);
         va_end(args);
         SDL_ShowSimpleMessageBox(SDL_MESSAGEBOX_ERROR, "Error", msg, sdl_window);
-        free(msg);
         exit(-1);
     }
 }

src/common/log.h

@@ -9,6 +9,8 @@
 #define LOG_ERROR(...) log_message(LOG_LEVEL_ERROR, __FILE__, __LINE__, __VA_ARGS__)
 #define LOG_FATAL(...) log_message(LOG_LEVEL_FATAL, __FILE__, __LINE__, __VA_ARGS__)
 
+#define FAIL_IF_NULL(ptr) if (ptr == NULL) { LOG_FATAL("Failed to allocate memory."); }
+
 typedef enum {
     LOG_LEVEL_EVERYTHING,
     LOG_LEVEL_DEBUG,