# game_config

**Repository Path**: raincoldl/game_config

## Basic Information

- **Project Name**: game_config
- **Description**: 游戏通用的配置库
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-03-24
- **Last Updated**: 2025-03-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Erlang

## README

game_config
=====

游戏配置模块，基于dynamic_compile将配置动态编译加载到内存中。

Build
-----

    $ rebar3 compile

用法
-----
1.将依赖添置到rebar.config的deps结构下。

    file: rebar.config

    {deps, [ {game_config, {git, "https://gitee.com/raincoldl/game_config.git", {branch, "master"}}}]}


2.想要加载配置，只需要在app启动的时候调用以下

    %% @doc 加载所有配置
    load_all_config() ->
        % 可选 - 设置默认的配置。
        game_config:set_default_config(?DEFAULT_CONFIG),
        % 加载所有配置。
        game_config:load_all_config(?CONFIG_DIR).

3.使用
    
    %% 获取默认配置 - 需要设置默认配置参考2步骤可选部分
    game_config:get_default(Key).
    game_config:get_default(Key, Default).

    %% 获取指定配置文件的配置
    game_config:get(ConfigKey, Key).
    game_config:get(ConfigKey, Key, Default).
    
    配置要求格式：
    文件名格式：xxx.config
    内容格式如下：
    每一个tuple为一个配置项，左侧为配置的Key,右侧为配置的Value。以.结尾
    %% =================
    %%      游戏项目相关
    %% =================
    {game_name, "just4fun"}.
    {server_id, 1}.
    
    则要获取游戏名称
    若加载配置的时候设置了默认配置为该配置，如xxx.config
    game_config:set_default_config("xxx"),
    则可以使用
    game_config:get_default(game_name). => "just4fun"
    或者
    game_config:get(xxx, game_name). => "just4fun"