Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,10 @@ branch or worktree when the existing checkout contains uncommitted changes.
- Use C++20 and consistent `snake_case` names, including types, functions and
members (`ark::plugin_manager`, `find_module()`, `module_name_`). Do not manually
edit generated protobuf output; change the schema or generation source.
- Use lowercase `snake_case` for plugin CMake targets and shared-library stems,
including official, server and sample plugins (`ark_mysql_plugin`,
`sample1_plugin`). Keep application manifests, launch scripts and documentation
aligned with the generated names; retain platform extensions and Debug `_d`.
- Follow `.clang-format` and the repository formatting scripts with clang-format
18. Keep function opening braces on the declaration line, expand short function
bodies, and use braces for control statements.
Expand Down
8 changes: 4 additions & 4 deletions build/conf/db.app.conf
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<xml>
<plugins plugin_lib_dir="bin/" plugin_conf_dir="conf/">
<plugin name="AFUtilityPlugin" conf="" />
<plugin name="AFConsulPlugin" conf="consul.plugin.conf" />
<plugin name="AFBusPlugin" conf="bus.plugin.conf" />
<plugin name="AFNetPlugin" conf="" />
<plugin name="ark_utility_plugin" conf="" />
<plugin name="ark_consul_plugin" conf="consul.plugin.conf" />
<plugin name="ark_bus_plugin" conf="bus.plugin.conf" />
<plugin name="ark_net_plugin" conf="" />
</plugins>
</xml>
10 changes: 5 additions & 5 deletions build/conf/dir.app.conf
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<xml>
<plugins plugin_lib_dir="bin/" plugin_conf_dir="conf/">
<plugin name="AFUtilityPlugin" conf="" />
<plugin name="AFConsulPlugin" conf="consul.plugin.conf" />
<plugin name="AFBusPlugin" conf="bus.plugin.conf" />
<plugin name="AFNetPlugin" conf="" />
<plugin name="AFDirPlugin" conf="" />
<plugin name="ark_utility_plugin" conf="" />
<plugin name="ark_consul_plugin" conf="consul.plugin.conf" />
<plugin name="ark_bus_plugin" conf="bus.plugin.conf" />
<plugin name="ark_net_plugin" conf="" />
<plugin name="ark_dir_plugin" conf="" />
</plugins>
</xml>
6 changes: 3 additions & 3 deletions build/conf/freebird.app.conf
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<plugins plugin_lib_dir="bin/" plugin_conf_dir="conf/">
<plugin name="AFUtilityPlugin" conf="" />
<plugin name="AFRedisPlugin" conf="redis.plugin.conf" />
<plugin name="AFHttpPlugin" conf="http.plugin.conf" />
<plugin name="ark_utility_plugin" conf="" />
<plugin name="ark_redis_plugin" conf="redis.plugin.conf" />
<plugin name="ark_http_plugin" conf="http.plugin.conf" />
<plugin name="AFFreeBirdPlugin" conf="freebird.plugin.conf" />
</plugins>
12 changes: 6 additions & 6 deletions build/conf/game.app.conf
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<xml>
<plugins plugin_lib_dir="bin/" plugin_conf_dir="conf/">
<plugin name="AFKernelPlugin" conf="kernel.plugin.conf" />
<plugin name="AFUtilityPlugin" conf="" />
<plugin name="AFConsulPlugin" conf="consul.plugin.conf" />
<plugin name="AFBusPlugin" conf="bus.plugin.conf" />
<plugin name="AFNetPlugin" conf="" />
<plugin name="AFGamePlugin" conf="" />
<plugin name="ark_kernel_plugin" conf="kernel.plugin.conf" />
<plugin name="ark_utility_plugin" conf="" />
<plugin name="ark_consul_plugin" conf="consul.plugin.conf" />
<plugin name="ark_bus_plugin" conf="bus.plugin.conf" />
<plugin name="ark_net_plugin" conf="" />
<plugin name="ark_game_plugin" conf="" />
</plugins>
<res path="resource/" />
</xml>
10 changes: 5 additions & 5 deletions build/conf/http_client_sample.app.conf
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<xml>
<plugins plugin_lib_dir="bin/" plugin_conf_dir="conf/">
<plugin name="AFUtilityPlugin" conf=""/>
<plugin name="AFBusPlugin" conf="bus.plugin.conf"/>
<plugin name="AFNetPlugin" conf="" />
<plugin name="AFEtcdClientPlugin" conf="" />
<plugin name="HttpClientSamplePlugin" conf="" />
<plugin name="ark_utility_plugin" conf=""/>
<plugin name="ark_bus_plugin" conf="bus.plugin.conf"/>
<plugin name="ark_net_plugin" conf="" />
<plugin name="ark_etcd_client_plugin" conf="" />
<plugin name="http_client_sample_plugin" conf="" />
</plugins>
</xml>
10 changes: 5 additions & 5 deletions build/conf/login.app.conf
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
<xml>
<plugins plugin_lib_dir="bin/" plugin_conf_dir="conf/">
<plugin name="AFUtilityPlugin" conf="" />
<plugin name="AFConsulPlugin" conf="consul.plugin.conf" />
<plugin name="AFBusPlugin" conf="bus.plugin.conf" />
<plugin name="AFNetPlugin" conf="" />
<plugin name="AFLoginPlugin" conf="" />
<plugin name="ark_utility_plugin" conf="" />
<plugin name="ark_consul_plugin" conf="consul.plugin.conf" />
<plugin name="ark_bus_plugin" conf="bus.plugin.conf" />
<plugin name="ark_net_plugin" conf="" />
<plugin name="ark_login_plugin" conf="" />
</plugins>
<res path="resource/" />
</xml>
10 changes: 5 additions & 5 deletions build/conf/master.app.conf
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
<xml>
<plugins plugin_lib_dir="bin/" plugin_conf_dir="conf/">
<plugin name="AFUtilityPlugin" conf="" />
<plugin name="AFConsulPlugin" conf="consul.plugin.conf" />
<plugin name="AFBusPlugin" conf="bus.plugin.conf" />
<plugin name="AFNetPlugin" conf="" />
<plugin name="AFMasterPlugin" conf="" />
<plugin name="ark_utility_plugin" conf="" />
<plugin name="ark_consul_plugin" conf="consul.plugin.conf" />
<plugin name="ark_bus_plugin" conf="bus.plugin.conf" />
<plugin name="ark_net_plugin" conf="" />
<plugin name="ark_master_plugin" conf="" />
</plugins>
<res path="resource/" />
</xml>
4 changes: 2 additions & 2 deletions build/conf/mysql_sample.app.conf
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<xml>
<plugins plugin_lib_dir="bin/" plugin_conf_dir="conf/">
<plugin name="AFMysqlPlugin" conf="mysql.plugin.conf" />
<plugin name="MysqlSamplePlugin" conf="" />
<plugin name="ark_mysql_plugin" conf="mysql.plugin.conf" />
<plugin name="mysql_sample_plugin" conf="" />
</plugins>
</xml>
8 changes: 4 additions & 4 deletions build/conf/oss.app.conf
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<xml>
<plugins plugin_lib_dir="bin/" plugin_conf_dir="conf/">
<plugin name="AFUtilityPlugin" conf="" />
<plugin name="AFConsulPlugin" conf="consul.plugin.conf" />
<plugin name="AFBusPlugin" conf="bus.plugin.conf" />
<plugin name="AFNetPlugin" conf="" />
<plugin name="ark_utility_plugin" conf="" />
<plugin name="ark_consul_plugin" conf="consul.plugin.conf" />
<plugin name="ark_bus_plugin" conf="bus.plugin.conf" />
<plugin name="ark_net_plugin" conf="" />
</plugins>
<res path="resource" />
</xml>
2 changes: 1 addition & 1 deletion build/conf/physic.app.conf
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<xml>
<plugins plugin_lib_dir="bin/" plugin_conf_dir="conf/">
<plugin name="AFPhysicPlugin" conf="" />
<plugin name="ark_physic_plugin" conf="" />
</plugins>
</xml>
12 changes: 6 additions & 6 deletions build/conf/proxy.app.conf
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
<xml>
<plugins plugin_lib_dir="bin/" plugin_conf_dir="conf/">
<plugin name="AFKernelPlugin" conf="kernel.plugin.conf" />
<plugin name="AFUtilityPlugin" conf="" />
<plugin name="AFConsulPlugin" conf="consul.plugin.conf" />
<plugin name="AFBusPlugin" conf="bus.plugin.conf" />
<plugin name="AFNetPlugin" conf="" />
<plugin name="AFProxyPlugin" conf="" />
<plugin name="ark_kernel_plugin" conf="kernel.plugin.conf" />
<plugin name="ark_utility_plugin" conf="" />
<plugin name="ark_consul_plugin" conf="consul.plugin.conf" />
<plugin name="ark_bus_plugin" conf="bus.plugin.conf" />
<plugin name="ark_net_plugin" conf="" />
<plugin name="ark_proxy_plugin" conf="" />
</plugins>
</xml>
6 changes: 3 additions & 3 deletions build/conf/realm.example.app.conf
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<?xml version="1.0"?>
<conf>
<plugins plugin_lib_dir="bin/" plugin_conf_dir="conf/">
<plugin name="AFUtilityPlugin" conf=""/>
<plugin name="AFBusPlugin" conf="bus.plugin.conf"/>
<plugin name="AFNetPlugin" conf=""/>
<plugin name="ark_utility_plugin" conf=""/>
<plugin name="ark_bus_plugin" conf="bus.plugin.conf"/>
<plugin name="ark_net_plugin" conf=""/>
<plugin name="RealmExamplePlugin" conf="realm.example.plugin.conf"/>
</plugins>
</conf>
8 changes: 4 additions & 4 deletions build/conf/realm.game.app.conf
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
<?xml version="1.0"?>
<conf>
<plugins plugin_lib_dir="bin/" plugin_conf_dir="conf/">
<plugin name="AFUtilityPlugin" conf=""/>
<plugin name="AFBusPlugin" conf="bus.plugin.conf"/>
<plugin name="AFNetPlugin" conf=""/>
<plugin name="ark_utility_plugin" conf=""/>
<plugin name="ark_bus_plugin" conf="bus.plugin.conf"/>
<plugin name="ark_net_plugin" conf=""/>
<plugin name="AFRealmGamePlugin" conf="realm.plugin.conf"/>
<plugin name="AFKafkaPlugin" conf=""/>
<plugin name="ark_kafka_plugin" conf=""/>
</plugins>
</conf>
6 changes: 3 additions & 3 deletions build/conf/realm.master.app.conf
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<?xml version="1.0"?>
<conf>
<plugins plugin_lib_dir="bin/" plugin_conf_dir="conf/">
<plugin name="AFUtilityPlugin" conf=""/>
<plugin name="AFBusPlugin" conf="bus.plugin.conf"/>
<plugin name="AFNetPlugin" conf=""/>
<plugin name="ark_utility_plugin" conf=""/>
<plugin name="ark_bus_plugin" conf="bus.plugin.conf"/>
<plugin name="ark_net_plugin" conf=""/>
<plugin name="AFRealmMasterPlugin" conf="realm.plugin.conf"/>
</plugins>
</conf>
6 changes: 3 additions & 3 deletions build/conf/redis_sample.app.conf
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<xml>
<plugins plugin_lib_dir="bin/" plugin_conf_dir="conf/">
<plugin name="AFUtilityPlugin" conf="" />
<plugin name="AFRedisPlugin" conf="redis.plugin.conf" />
<plugin name="RedisSamplePlugin" conf="" />
<plugin name="ark_utility_plugin" conf="" />
<plugin name="ark_redis_plugin" conf="redis.plugin.conf" />
<plugin name="redis_sample_plugin" conf="" />
</plugins>
</xml>
8 changes: 4 additions & 4 deletions build/conf/remote_log.app.conf
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<xml>
<plugins plugin_lib_dir="bin/" plugin_conf_dir="conf/">
<plugin name="AFUtilityPlugin" conf="" />
<plugin name="AFConsulPlugin" conf="consul.plugin.conf" />
<plugin name="AFBusPlugin" conf="bus.plugin.conf" />
<plugin name="AFNetPlugin" conf="" />
<plugin name="ark_utility_plugin" conf="" />
<plugin name="ark_consul_plugin" conf="consul.plugin.conf" />
<plugin name="ark_bus_plugin" conf="bus.plugin.conf" />
<plugin name="ark_net_plugin" conf="" />
</plugins>
</xml>
8 changes: 4 additions & 4 deletions build/conf/router.app.conf
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<xml>
<plugins plugin_lib_dir="bin/" plugin_conf_dir="conf/">
<plugin name="AFUtilityPlugin" conf="" />
<plugin name="AFConsulPlugin" conf="consul.plugin.conf" />
<plugin name="AFBusPlugin" conf="bus.plugin.conf" />
<plugin name="AFNetPlugin" conf="" />
<plugin name="ark_utility_plugin" conf="" />
<plugin name="ark_consul_plugin" conf="consul.plugin.conf" />
<plugin name="ark_bus_plugin" conf="bus.plugin.conf" />
<plugin name="ark_net_plugin" conf="" />
</plugins>
</xml>
4 changes: 2 additions & 2 deletions build/conf/sample1.app.conf
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<xml>
<plugins plugin_lib_dir="bin/" plugin_conf_dir="conf/">
<plugin name="AFUtilityPlugin" conf="" />
<plugin name="Sample1Plugin" conf="" />
<plugin name="ark_utility_plugin" conf="" />
<plugin name="sample1_plugin" conf="" />
</plugins>
</xml>
4 changes: 2 additions & 2 deletions build/conf/sample1.app.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ plugin_library_dir = "bin/"
plugin_config_dir = "conf/"

[[plugins]]
name = "AFUtilityPlugin"
name = "ark_utility_plugin"
config = ""

[[plugins]]
name = "Sample1Plugin"
name = "sample1_plugin"
6 changes: 3 additions & 3 deletions build/conf/sample2.app.conf
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<xml>
<plugins plugin_lib_dir="bin/" plugin_conf_dir="conf/">
<plugin name="AFKernelPlugin" conf="kernel.plugin.conf" />
<plugin name="AFUtilityPlugin" conf="" />
<plugin name="Sample2Plugin" conf="" />
<plugin name="ark_kernel_plugin" conf="kernel.plugin.conf" />
<plugin name="ark_utility_plugin" conf="" />
<plugin name="sample2_plugin" conf="" />
</plugins>
</xml>
6 changes: 3 additions & 3 deletions build/conf/sample3.app.conf
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<xml>
<plugins plugin_lib_dir="bin/" plugin_conf_dir="conf/">
<plugin name="AFKernelPlugin" conf="kernel.plugin.conf" />
<plugin name="AFUtilityPlugin" conf="" />
<plugin name="Sample3Plugin" conf="" />
<plugin name="ark_kernel_plugin" conf="kernel.plugin.conf" />
<plugin name="ark_utility_plugin" conf="" />
<plugin name="sample3_plugin" conf="" />
</plugins>
</xml>
6 changes: 3 additions & 3 deletions build/conf/sample4.app.conf
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<xml>
<plugins plugin_lib_dir="bin/" plugin_conf_dir="conf/">
<plugin name="AFUtilityPlugin" conf="" />
<plugin name="AFPhysicPlugin" conf="" />
<plugin name="Sample4Plugin" conf="" />
<plugin name="ark_utility_plugin" conf="" />
<plugin name="ark_physic_plugin" conf="" />
<plugin name="sample4_plugin" conf="" />
</plugins>
</xml>
6 changes: 3 additions & 3 deletions build/conf/sample5.app.conf
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<xml>
<plugins plugin_lib_dir="bin/" plugin_conf_dir="conf/">
<plugin name="AFUtilityPlugin" conf="" />
<plugin name="AFHttpPlugin" conf="http.plugin.conf" />
<plugin name="Sample5Plugin" conf="" />
<plugin name="ark_utility_plugin" conf="" />
<plugin name="ark_http_plugin" conf="http.plugin.conf" />
<plugin name="sample5_plugin" conf="" />
</plugins>
</xml>
12 changes: 6 additions & 6 deletions build/conf/simulate.app.conf
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
<xml>
<plugins plugin_lib_dir="bin/" plugin_conf_dir="conf/">
<plugin name="AFPhysicPlugin" conf="" />
<plugin name="AFBusPlugin" conf="bus.plugin.conf" />
<plugin name="AFNetPlugin" conf="" />
<plugin name="AFConsulPlugin" conf="consul.plugin.conf" />
<plugin name="AFUtilityPlugin" conf="" />
<plugin name="AFSimulatePlugin" conf="" />
<plugin name="ark_physic_plugin" conf="" />
<plugin name="ark_bus_plugin" conf="bus.plugin.conf" />
<plugin name="ark_net_plugin" conf="" />
<plugin name="ark_consul_plugin" conf="consul.plugin.conf" />
<plugin name="ark_utility_plugin" conf="" />
<plugin name="ark_simulate_plugin" conf="" />
</plugins>
</xml>
8 changes: 4 additions & 4 deletions build/conf/terraria.game.app.conf
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<xml>
<plugins plugin_lib_dir="bin/" plugin_conf_dir="conf/">
<plugin name="AFUtilityPlugin" conf=""/>
<plugin name="AFBusPlugin" conf="bus.plugin.conf"/>
<plugin name="AFNetPlugin" conf=""/>
<plugin name="AFConsulPlugin" conf="consul.plugin.conf"/>
<plugin name="ark_utility_plugin" conf=""/>
<plugin name="ark_bus_plugin" conf="bus.plugin.conf"/>
<plugin name="ark_net_plugin" conf=""/>
<plugin name="ark_consul_plugin" conf="consul.plugin.conf"/>
<plugin name="TerrariaGame" conf="terraria.game.plugin.conf" />
</plugins>
</xml>
12 changes: 6 additions & 6 deletions build/conf/world.app.conf
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<xml>
<plugins path="./">
<plugin name="AFKernelPlugin" />
<plugin name="AFUtilityPlugin" />
<plugin name="AFConsulPlugin" />
<plugin name="AFBusPlugin" />
<plugin name="AFNetPlugin" />
<plugin name="AFWorldPlugin" />
<plugin name="ark_kernel_plugin" />
<plugin name="ark_utility_plugin" />
<plugin name="ark_consul_plugin" />
<plugin name="ark_bus_plugin" />
<plugin name="ark_net_plugin" />
<plugin name="ark_world_plugin" />
</plugins>
<res path="resource/" />
</xml>
6 changes: 3 additions & 3 deletions docs/concepts/application-architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ The launcher receives `--busid`, `--name` and `--app_conf`. The application mani
```xml
<xml>
<plugins plugin_lib_dir="bin/" plugin_conf_dir="conf/">
<plugin name="AFUtilityPlugin" conf="" />
<plugin name="Sample1Plugin" conf="" />
<plugin name="ark_utility_plugin" conf="" />
<plugin name="sample1_plugin" conf="" />
</plugins>
</xml>
```
Expand All @@ -21,7 +21,7 @@ New application manifests can use TOML; the equivalent [sample1.app.toml](https:

The loader loads each library and calls its exported plugin entry. `sample1_plugin::install()` registers `sample1_module`; the utility plugin provides services such as timers. A module resolves those services with `find_module<timer_module>()`, rather than creating another copy of the utility plugin.

The manifest's names are runtime library names. Existing `AFUtilityPlugin` / `Sample1Plugin` names do not follow the C++ class spelling and must match the built artifacts. Debug libraries use the configured `_d` postfix. An empty `conf` supplies no configuration filename; the loader itself does not parse plugin-specific content.
The manifest's names are runtime library names. Existing `ark_utility_plugin` / `sample1_plugin` names do not follow the C++ class spelling and must match the built artifacts. Debug libraries use the configured `_d` postfix. An empty `conf` supplies no configuration filename; the loader itself does not parse plugin-specific content.

## Paths and a runnable starting point

Expand Down
6 changes: 3 additions & 3 deletions docs/concepts/application-architecture_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ ark 应用是由选定插件库组成的进程。一个插件可以注册多个
```xml
<xml>
<plugins plugin_lib_dir="bin/" plugin_conf_dir="conf/">
<plugin name="AFUtilityPlugin" conf="" />
<plugin name="Sample1Plugin" conf="" />
<plugin name="ark_utility_plugin" conf="" />
<plugin name="sample1_plugin" conf="" />
</plugins>
</xml>
```
Expand All @@ -21,7 +21,7 @@ ark 应用是由选定插件库组成的进程。一个插件可以注册多个

加载器依次加载库并调用导出的插件入口。`sample1_plugin::install()` 注册 `sample1_module`,Utility 插件提供定时器等服务。模块通过 `find_module<timer_module>()` 获取这些服务,不需要再创建一份 Utility 插件。

清单名称是运行时库名。现有 `AFUtilityPlugin`、`Sample1Plugin` 不等同于 C++ 类名拼写,必须与构建产物匹配。Debug 库使用配置的 `_d` 后缀。空 `conf` 不提供配置文件名,加载器本身不解析插件专属内容。
清单名称是运行时库名。现有 `ark_utility_plugin`、`sample1_plugin` 不等同于 C++ 类名拼写,必须与构建产物匹配。Debug 库使用配置的 `_d` 后缀。空 `conf` 不提供配置文件名,加载器本身不解析插件专属内容。

## 路径与运行入口

Expand Down
Loading
Loading