1.0 KiB
1.0 KiB
HearthMod Build Commands and Code Guidelines
Build Commands
docker-compose up --build- Build and start the project containerbash docker_ctl.sh compile- Compile and install server stackbash docker_ctl.sh start- Start server stackbash docker_ctl.sh stop- Stop server stack- Component-specific:
cd hm_gameserver && make - Base library:
make -C ../hm_base target=game
Code Style Guidelines
- Indentation: 4 spaces for C/C++/Python
- Naming:
- C: snake_case for functions/variables, UPPER_SNAKE_CASE for constants
- C++: camelCase for methods/variables, UPPER_SNAKE_CASE for constants
- Structs use _s suffix, enums use _e suffix
- Headers: System includes first, then project includes
- Error handling: Functions return int (0=success, negative=failure)
- Logging: Use
hm_log(LOG_LEVEL, log_instance, "message") - Memory: Always free allocated resources, use pooled allocation when possible
- Initialization: Follow component-specific init/cleanup patterns