开源项目 `quirrel` 使用教程

开源项目 quirrel 使用教程

quirrelQuirrel - Gaijin Entertainment dynamic script language项目地址:https://gitcode.com/gh_mirrors/qui/quirrel

1. 项目目录结构及介绍

quirrel/
├── bin/
│   ├── qurrel_server
│   └── qurrel_client
├── config/
│   ├── config.json
│   └── logging.conf
├── src/
│   ├── main.cpp
│   ├── utils.cpp
│   └── utils.h
├── include/
│   ├── qurrel.h
│   └── utils.h
├── tests/
│   ├── test_main.cpp
│   └── test_utils.cpp
├── README.md
└── LICENSE

目录结构说明：

• bin/：存放编译后的可执行文件，包括 quirrel_server 和 quirrel_client。
• config/：存放项目的配置文件，如 config.json 和 logging.conf。
• src/：存放项目的源代码文件，包括 main.cpp 和 utils.cpp。
• include/：存放项目的头文件，如 quirrel.h 和 utils.h。
• tests/：存放项目的测试代码文件，如 test_main.cpp 和 test_utils.cpp。
• README.md：项目的说明文档。
• LICENSE：项目的开源许可证文件。

2. 项目启动文件介绍

bin/quirrel_server

• 功能：这是 quirrel 项目的服务器端可执行文件。
• 启动方式：在终端中运行 ./bin/quirrel_server 即可启动服务器。

bin/quirrel_client

• 功能：这是 quirrel 项目的客户端可执行文件。
• 启动方式：在终端中运行 ./bin/quirrel_client 即可启动客户端。

3. 项目配置文件介绍

config/config.json

• 功能：这是 quirrel 项目的主要配置文件，用于配置服务器和客户端的各种参数。
• 示例内容：

  {
    "server_ip": "127.0.0.1",
    "server_port": 8080,
    "max_connections": 100,
    "log_level": "info"
  }
  

config/logging.conf

• 功能：这是 quirrel 项目的日志配置文件，用于配置日志的输出格式和级别。
• 示例内容：

  [loggers]
  keys=root
  
  [handlers]
  keys=consoleHandler
  
  [formatters]
  keys=simpleFormatter
  
  [logger_root]
  level=DEBUG
  handlers=consoleHandler
  
  [handler_consoleHandler]
  class=StreamHandler
  level=DEBUG
  formatter=simpleFormatter
  args=(sys.stdout,)
  
  [formatter_simpleFormatter]
  format=%(asctime)s - %(name)s - %(levelname)s - %(message)s
  

以上是 quirrel 项目的目录结构、启动文件和配置文件的详细介绍。希望这份教程能帮助你更好地理解和使用该项目。

quirrelQuirrel - Gaijin Entertainment dynamic script language项目地址:https://gitcode.com/gh_mirrors/qui/quirrel