Compare commits
7
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
270808e602 | ||
|
|
053f8a14c8 | ||
|
|
6429e29084 | ||
|
|
5509c18b17 | ||
|
|
cc39200917 | ||
|
|
95d7191fdd | ||
|
|
eb4b4c1f80 |
+19
-1
@@ -7,6 +7,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
||||
|
||||
## [Unreleased]
|
||||
|
||||
## [1.0.0] - 2026-09-29
|
||||
|
||||
### Added
|
||||
- `module_template/`: copyable starting point for a native stk module, builds cross-platform out of the box
|
||||
|
||||
## [1.0.0-pre.12] - 2026-03-29
|
||||
|
||||
### Fixed
|
||||
- `gmake.mk`: changed static library extension on Windows from `.lib` to `.a` for MinGW compatibility
|
||||
- `module_loader`: use `RTLD_GLOBAL` when loading modules to correctly expose host symbols to dynamic libraries
|
||||
|
||||
## [1.0.0-pre.11] - 2026-03-15
|
||||
|
||||
### Fixed
|
||||
- `gmake.mk`: `PREFIX` now defaults to `/usr` on Linux instead of `/usr/local`
|
||||
|
||||
## [1.0.0-pre.10] - 2026-03-14
|
||||
|
||||
### Fixed
|
||||
@@ -207,7 +223,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
||||
- Dependency management and versioning not yet implemented
|
||||
- API is unstable and subject to change in future releases
|
||||
|
||||
[Unreleased]: https://github.com/anth64/stk/compare/v1.0.0-pre.10...HEAD
|
||||
[Unreleased]: https://github.com/anth64/stk/compare/v1.0.0-pre.12...HEAD
|
||||
[1.0.0-pre.12]: https://github.com/anth64/stk/compare/v1.0.0-pre.11...v1.0.0-pre.12
|
||||
[1.0.0-pre.11]: https://github.com/anth64/stk/compare/v1.0.0-pre.10...v1.0.0-pre.11
|
||||
[1.0.0-pre.10]: https://github.com/anth64/stk/compare/v1.0.0-pre.9...v1.0.0-pre.10
|
||||
[1.0.0-pre.9]: https://github.com/anth64/stk/compare/v1.0.0-pre.8...v1.0.0-pre.9
|
||||
[1.0.0-pre.8]: https://github.com/anth64/stk/compare/v1.0.0-pre.7...v1.0.0-pre.8
|
||||
|
||||
@@ -46,7 +46,7 @@ build.bat debug release
|
||||
./build.sh install
|
||||
```
|
||||
|
||||
Installs to `/usr/local` by default. Use `PREFIX` to customize:
|
||||
Installs to `/usr` on Linux, `/usr/local` on BSD/macOS by default. Use `PREFIX` to customize:
|
||||
```bash
|
||||
./build.sh PREFIX=$HOME/.local install
|
||||
```
|
||||
@@ -131,6 +131,8 @@ cc -shared -o my_module.dll my_module.c
|
||||
|
||||
Place the compiled module in the `mods/` directory (default), and `stk` will automatically load it and watch for changes.
|
||||
|
||||
Copy `module_template/` as a starting point, it builds cross-platform out of the box.
|
||||
|
||||
### Module Metadata
|
||||
|
||||
Modules can optionally export metadata functions:
|
||||
@@ -234,7 +236,7 @@ stk_init();
|
||||
|
||||
## Project Status
|
||||
|
||||
**Current Version:** 1.0.0-pre.10
|
||||
**Current Version:** 1.0.0
|
||||
|
||||
### What Works
|
||||
- Cross-platform module loading and hot-reloading
|
||||
|
||||
@@ -3,7 +3,7 @@ include config.mk
|
||||
ifeq ($(OS),Windows_NT)
|
||||
SHELL := cmd.exe
|
||||
FULL_LIB := $(LIB_NAME).dll
|
||||
STATIC_LIB := $(LIB_NAME).lib
|
||||
STATIC_LIB := lib$(LIB_NAME).a
|
||||
LDFLAGS_PLAT :=
|
||||
CFLAGS_PLAT :=
|
||||
CFLAGS_STATIC :=
|
||||
@@ -22,7 +22,7 @@ endif
|
||||
RELEASE_LDFLAGS := -s
|
||||
CFLAGS_BASE := -Wall -Wpedantic -I$(INC_DIR) -std=c89 $(CFLAGS_PLAT)
|
||||
|
||||
PREFIX ?= /usr/local
|
||||
PREFIX ?= /usr
|
||||
LIBDIR ?= $(PREFIX)/lib
|
||||
INCDIR ?= $(PREFIX)/include
|
||||
|
||||
|
||||
@@ -0,0 +1,3 @@
|
||||
# Build directories
|
||||
obj/
|
||||
bin/
|
||||
@@ -0,0 +1,20 @@
|
||||
# my_module
|
||||
|
||||
TODO: one-line description.
|
||||
|
||||
An stk module.
|
||||
|
||||
## Build
|
||||
|
||||
```bash
|
||||
./build.sh debug release # Linux/BSD/macOS
|
||||
build.bat debug release # Windows
|
||||
```
|
||||
|
||||
## Install
|
||||
|
||||
Copy `bin/release/my_module.so`/`.dylib`/`.dll` into the game's `mods/` directory.
|
||||
|
||||
## Dependencies
|
||||
|
||||
TODO: list any, or delete this section.
|
||||
@@ -0,0 +1,43 @@
|
||||
.include "config.mk"
|
||||
|
||||
UNAME_S != uname -s
|
||||
|
||||
.if ${UNAME_S} == "Darwin"
|
||||
MODULE_EXT = .dylib
|
||||
.else
|
||||
MODULE_EXT = .so
|
||||
.endif
|
||||
|
||||
CC ?= cc
|
||||
CFLAGS_BASE = -Wall -Wpedantic -I${.CURDIR}/${INC_DIR} -fPIC
|
||||
|
||||
.PHONY: all debug release clean
|
||||
|
||||
all: debug
|
||||
|
||||
OBJS_DEBUG = ${SRCS:S|^src/|${.CURDIR}/obj/debug/|:S/.c$/.o/}
|
||||
OBJS_RELEASE = ${SRCS:S|^src/|${.CURDIR}/obj/release/|:S/.c$/.o/}
|
||||
|
||||
debug: ${.CURDIR}/${BIN_DIR}/debug/${MODULE_NAME}${MODULE_EXT}
|
||||
release: ${.CURDIR}/${BIN_DIR}/release/${MODULE_NAME}${MODULE_EXT}
|
||||
|
||||
${.CURDIR}/${BIN_DIR}/debug/${MODULE_NAME}${MODULE_EXT}: ${OBJS_DEBUG}
|
||||
@mkdir -p ${.TARGET:H}
|
||||
${CC} -shared -o ${.TARGET} ${.ALLSRC}
|
||||
|
||||
${.CURDIR}/${BIN_DIR}/release/${MODULE_NAME}${MODULE_EXT}: ${OBJS_RELEASE}
|
||||
@mkdir -p ${.TARGET:H}
|
||||
${CC} -shared -s -o ${.TARGET} ${.ALLSRC}
|
||||
|
||||
.for _src in ${SRCS}
|
||||
${.CURDIR}/obj/debug/${_src:S|^src/||:S/.c$/.o/}: ${.CURDIR}/${_src}
|
||||
@mkdir -p ${.TARGET:H}
|
||||
${CC} ${CFLAGS_BASE} -g -O0 -MMD -MP -MT ${.TARGET} -MF ${.TARGET:S/.o$/.d/} -c ${.ALLSRC} -o ${.TARGET}
|
||||
|
||||
${.CURDIR}/obj/release/${_src:S|^src/||:S/.c$/.o/}: ${.CURDIR}/${_src}
|
||||
@mkdir -p ${.TARGET:H}
|
||||
${CC} ${CFLAGS_BASE} -O2 -MMD -MP -MT ${.TARGET} -MF ${.TARGET:S/.o$/.d/} -c ${.ALLSRC} -o ${.TARGET}
|
||||
.endfor
|
||||
|
||||
clean:
|
||||
rm -rf ${.CURDIR}/${OBJ_DIR} ${.CURDIR}/${BIN_DIR}
|
||||
@@ -0,0 +1,2 @@
|
||||
@echo off
|
||||
make -f gmake.mk %*
|
||||
Executable
+11
@@ -0,0 +1,11 @@
|
||||
#!/bin/sh
|
||||
|
||||
OS=$(uname -s | tr '[:upper:]' '[:lower:]')
|
||||
|
||||
if [ "$OS" = "linux" ]; then
|
||||
MK_FILE="gmake.mk"
|
||||
else
|
||||
MK_FILE="bmake.mk"
|
||||
fi
|
||||
|
||||
make -f "$MK_FILE" "$@"
|
||||
@@ -0,0 +1,4 @@
|
||||
-xc
|
||||
-Wall
|
||||
-Wpedantic
|
||||
-Iinclude
|
||||
@@ -0,0 +1,8 @@
|
||||
SRC_DIR = src
|
||||
INC_DIR = include
|
||||
OBJ_DIR = obj
|
||||
BIN_DIR = bin
|
||||
|
||||
MODULE_NAME = my_module
|
||||
|
||||
SRCS = src/module.c
|
||||
@@ -0,0 +1,45 @@
|
||||
include config.mk
|
||||
|
||||
ifeq ($(OS),Windows_NT)
|
||||
SHELL := cmd.exe
|
||||
MODULE_EXT = .dll
|
||||
MKDIR = if not exist $(subst /,\,$(1)) mkdir $(subst /,\,$(1))
|
||||
RMDIR = if exist $(subst /,\,$(1)) rd /s /q $(subst /,\,$(1))
|
||||
else
|
||||
MODULE_EXT = .so
|
||||
MKDIR = mkdir -p $(1)
|
||||
RMDIR = rm -rf $(1)
|
||||
endif
|
||||
|
||||
CC = cc
|
||||
CFLAGS_BASE = -Wall -Wpedantic -I$(INC_DIR) -fPIC
|
||||
|
||||
.PHONY: all debug release clean
|
||||
|
||||
all: debug
|
||||
|
||||
debug: $(BIN_DIR)/debug/$(MODULE_NAME)$(MODULE_EXT)
|
||||
release: $(BIN_DIR)/release/$(MODULE_NAME)$(MODULE_EXT)
|
||||
|
||||
$(BIN_DIR)/debug/$(MODULE_NAME)$(MODULE_EXT): $(SRCS:src/%.c=obj/debug/%.o)
|
||||
@$(call MKDIR,$(@D))
|
||||
$(CC) -shared -o $@ $^
|
||||
|
||||
obj/debug/%.o: src/%.c
|
||||
@$(call MKDIR,$(@D))
|
||||
$(CC) $(CFLAGS_BASE) -g -O0 -MMD -MP -c $< -o $@
|
||||
|
||||
$(BIN_DIR)/release/$(MODULE_NAME)$(MODULE_EXT): $(SRCS:src/%.c=obj/release/%.o)
|
||||
@$(call MKDIR,$(@D))
|
||||
$(CC) -shared -s -o $@ $^
|
||||
|
||||
obj/release/%.o: src/%.c
|
||||
@$(call MKDIR,$(@D))
|
||||
$(CC) $(CFLAGS_BASE) -O2 -MMD -MP -c $< -o $@
|
||||
|
||||
-include $(wildcard obj/debug/*.d)
|
||||
-include $(wildcard obj/release/*.d)
|
||||
|
||||
clean:
|
||||
@$(call RMDIR,$(OBJ_DIR))
|
||||
@$(call RMDIR,$(BIN_DIR))
|
||||
@@ -0,0 +1,16 @@
|
||||
#ifndef MODULE_VERSION_H
|
||||
#define MODULE_VERSION_H
|
||||
|
||||
#define MY_MODULE_VERSION_MAJOR 0
|
||||
#define MY_MODULE_VERSION_MINOR 1
|
||||
#define MY_MODULE_VERSION_PATCH 0
|
||||
|
||||
#define MY_MODULE_STRINGIFY_HELPER(x) #x
|
||||
#define MY_MODULE_STRINGIFY(x) MY_MODULE_STRINGIFY_HELPER(x)
|
||||
|
||||
#define MY_MODULE_VERSION_STRING \
|
||||
MY_MODULE_STRINGIFY(MY_MODULE_VERSION_MAJOR) \
|
||||
"." MY_MODULE_STRINGIFY(MY_MODULE_VERSION_MINOR) "." MY_MODULE_STRINGIFY( \
|
||||
MY_MODULE_VERSION_PATCH)
|
||||
|
||||
#endif /* MODULE_VERSION_H */
|
||||
@@ -0,0 +1,38 @@
|
||||
#include "module_version.h"
|
||||
#include <stdio.h>
|
||||
|
||||
/* on load */
|
||||
int stk_mod_init(void)
|
||||
{
|
||||
printf("my_module initialized!\n");
|
||||
return 0;
|
||||
}
|
||||
|
||||
/* on unload/reload */
|
||||
void stk_mod_shutdown(void) { printf("my_module shut down.\n"); }
|
||||
|
||||
const char *stk_mod_name(void) { return "my_module"; }
|
||||
const char *stk_mod_version(void) { return MY_MODULE_VERSION_STRING; }
|
||||
const char *stk_mod_description(void) { return "TODO: describe this module"; }
|
||||
|
||||
/*
|
||||
* declares which other modules must be loaded first.
|
||||
* id = dependency's filename, minus extension.
|
||||
* layout must match stk_dep_t: id[64], version[32].
|
||||
* sentinel ("","") required, always last.
|
||||
*
|
||||
* =1.0.0 exact
|
||||
* >=1.0.0 minimum (default)
|
||||
* ^1.0.0 same major
|
||||
*/
|
||||
/*
|
||||
typedef struct {
|
||||
char id[64];
|
||||
char version[32];
|
||||
} dep_t;
|
||||
|
||||
dep_t stk_mod_deps[] = {
|
||||
{ "physics", ">=2.0.0" },
|
||||
{ "", "" }
|
||||
};
|
||||
*/
|
||||
+1
-1
@@ -278,7 +278,7 @@ void *platform_load_library(const char *path)
|
||||
#ifdef _WIN32
|
||||
return (void *)LoadLibraryA(path);
|
||||
#else
|
||||
return dlopen(path, RTLD_NOW);
|
||||
return dlopen(path, RTLD_NOW | RTLD_GLOBAL);
|
||||
#endif
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user