KEngine策劃指南:配置Excel表格的編輯與編譯

KSFramework是一個Unity 5 Asset Bundle開發框架和工具集,專注于運行時熱重載,使用了SLua作為腳本引擎。

策劃與程序的橋梁

執行策劃在游戲開發的過程中的主要工作是什么?當然就是和Excel打交道了。大量的Excel數據表,最終會被演變成游戲的配置數據。日常游戲開發中,策劃編輯配置表一般有兩種方式:

  • 編譯式:策劃編輯Excel,經過中間程序轉成csv、lua、json等程序可讀的文本格式;
  • 直接擼式:策劃直接編輯Lua和使用Excel編輯TSV(CSV)等程序可讀的格式;

而程序讀取,理論上也因此有幾種方式:

  • 自動生成配置讀取代碼:自動根據策劃編輯的Excel和規范,自動生成所有加載配置表的代碼;
  • 手工寫讀取配置表的代碼:這是常見的方式,但往往一個項目下來,手寫的配置表的代碼不但大量,而且伴隨策劃配置的修改需要頻繁的維護;

對策劃來說,直接擼Lua或csv,體驗肯定不如直接編輯Excel來得爽快;對程序來說,讀表這種無技術含量的重復勞動,自然不如自動來得爽快。

KEngine中的配置模塊,使用了編譯式配置表,對Excel表有輕度的規范,策劃可以根據自身需要,添加文檔、注釋、圖標、批注等等各種輔助信息;并自動化生成出程序代碼配置表加載API,供程序直接使用。

配置表的編輯和編譯

KEngine中,配置表源文件,即編譯前的表,默認放置在Product/SettingSource目錄中;編譯后的配置文件放置在Assets/StreamingAssets/Setting目錄中。

Excel表格規則

該目錄的Excel文件都要遵循以下的4條規則:

  1. 第一個表單(Sheet)為需要編譯的內容
  • 表單的第一行是列名,如Id,Name等
  • 表單的第二行是列配置信息,如string/default,意思是列是string字符串類型,默認值是default; KEngine目前只使用前兩位信息
  • 表單的第三行是注釋,可以添加對列名的一些解釋,最常用莫過于為英文的列明配上中文的注釋了

最終效果如圖:

** 使用編譯模式的最大好處,策劃人員可以在Excel上進行注釋、圖表、批注等附加工作,甚至可以把一些文字描述文檔,放到Sheet2。讓配置表與文檔結合在一起。 **

注釋的行或列

除了第三行注釋行,配置表模塊還有兩個添加注釋的規則:

  • 表單中,非頭三行內容,行的第一個單元格內容為“#”或“Comment”時,認為這一行是注釋行;
  • 表單中,列名單元格內容為“#”或“Comment”時,認為這一列是注釋列;

拆分表格

日常的開發中,我們有時候會嫌一個Excel文件內容過多,希望將其進行拆分;同時也方便多人協作。

文件名中使用“+”進行拆表

KEngine在編譯時,對文件名處理施展了一點點魔法:當文件名中存在+號時,會裁掉+號后邊的內容

比如這3個文件:AppConfig+A.xlsx,AppConfig+B.xlsx,AppConfig+C.xlsx,在編譯時,會統一合并成AppConfig.xlsx。

但是要注意,務必確保這三個文件的表頭信息要一樣的。

配置表格的編譯

Excel另存為中的“制表符分隔”文本文件就是所謂的TSV

TSV,類似CSV,即Tab-sepertated Values,類似CSV表格,僅僅是分隔符從逗號變成了Tab。 就我公司所經歷的所有游戲項目,策劃均直接用Excel擼TSV格式配置表。

KEngine配置表編譯的本質,其實就是——把Excel文件轉換成純文本TSV格式文件。而在編譯過程中,會刪掉注釋內容:第三行的注釋,帶#井號的注釋等。

上圖中的Excel,經過編譯后變成的TSV文件內容:

**Excel文件經過編譯后變成TSV格式的表格,并且去掉了注釋行。**

如何在Unity中觸發KEngine對Excel表格編譯?

菜單KEngine->Setting中的配置表功能

執行菜單KEngine->Setting中的兩個編譯配置表功能項:

  • Force Compile Settings + Code:強制重新編譯所有的表,并且自動生成配置表代碼(會觸發Unity重新編譯)
  • Quick Compile Settings:差異化編譯配置表,不重新自動生成配置表代碼

配置表的文件監測

為了方便開發,在打開Unity編輯器后KEngine會對所有的配置表源文件進行監測,當發現Excel文件有改動,Unity編輯器就會彈框請求進行配置表重新編譯(執行Quick Compile Settings差異化編譯)

對Excel文件改動后,Unity會監測到變更,點擊OK,就會重新編譯

不過,當修改配置表時并沒有打開帶有KEngine的Unity工程,就無法監測到配置表的變更,這時就需要手工執行菜單的配置表格編譯了。

配置表讀取的代碼生成

根據Excel配置表的頭部信息,KEngine會在Unity Assets根目錄(可通過EngineConfigs.txt這個INI文件進行配置)生成一個AppSettings.cs文件。這個文件包含了所有的配置表的讀取代碼。

直接來看看配置表代碼的調用方法——獲取所有、獲取某個、熱重載:


// 獲取所有的配置項
foreach (GameConfigSetting config in GameConfigSettings.GetAll()) // Get all Configs
{
    Debug.Log(string.Format("C# Read Config, Key: {0}, Value: {1}", config.Id, config.Value));
}

// 獲取指定Key的配置項,Key為第一列
var testConfig = GameConfigSettings.Get("Test"); // Get by key

// 熱重載
GameConfigSettings.GetInstance().ReloadAll(); // Reload while settings recompile
生成代碼的GameConfig.xlsx

Excel表GameConfig.xlsx,會生成一個類GameConfigSettings,放置在AppSettings.cs代碼文件中。

惰式初始化

生成的代碼中,采用了惰式初始化方式進行配置表的加載: 即第一次使用時進行初始化

從而避免游戲啟動時的集中式初始化,降低啟動時間,優化執行性能。

// 預熱GameConfig表
GameConfigSettings.GetInstance(),
// 預熱所有的表
SettingsManager.AllSettingsReload();

可是,實際開發過程中,我就是想針對某些表,先初始化,再進游戲?
根據第一次使用時進行初始化的原則,強制在初始化階段進行一次調用就可以單例調用,就可以觸發初始化。

熱重載

對策劃來說,簡單的修改Excel配置表后,往往需要重啟游戲,來看修改的效果。

KEngine配置表提供一種方法,可以在不重啟游戲的前提下,重載配置表,來立即查看效果。

生成的配置表代碼中,會監測其加載過的編譯后的配置文件,當配置文件發生變化,就會進行重載。

如果文件監測失靈,你也可以通過菜單項來主動重載:

通過菜單熱重載配置表

其他

既然KEngine中使用了Excel這種非純文本格式進行配置表的編輯,那么在配合SVN等版本管理工具時,如何進行差異化的配置表比較?可參詳:《KEngine:Excel如何進行SVN協作、差異比較?》

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,505評論 6 533
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,556評論 3 418
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,463評論 0 376
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,009評論 1 312
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,778評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,218評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,281評論 3 441
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,436評論 0 288
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,969評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,795評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,993評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,537評論 5 359
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,229評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,659評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,917評論 1 286
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,687評論 3 392
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,990評論 2 374

推薦閱讀更多精彩內容