使用JSPWiki豐富Unity-UPM包的使用

HONT發表於2020-08-09

 

1.簡述

諸如npm、Nuget之類的包管理工具,Unity推出了自己的Unity Package Manager(UPM)工具來管理使用到的第三方庫。

現在Unity Package Manager可以直接允許我們匯入git倉庫進行連結。

 

 

2.UPM庫的配置與連結

通過Unity官方文件的教程可進行UPM庫的配置與連結的參考:

https://docs.unity3d.com/Manual/CustomPackages.html

 

這裡以Unity 2019.4.3f1為例,建立一個名為Test1的資料夾作為測試。根據官方提供的資料夾規則,

建立Runtime資料夾並將具體指令碼及資原始檔置於其中。

隨後在Runtime資料夾中建立asmdef檔案,該檔案可以將資料夾內的部分打包進單獨的動態資源庫。

asmdef檔案可以通過Project皮膚中右鍵Create->Assembly Definition進行建立。

 

根據上面的資料夾規則,接下來建立package.json檔案,Unity在得到庫的git地址後,會查詢該檔案獲取配置資訊。

目前版本的unity對git倉庫引用的包支援有限,在包體描述中不能插入URL超連結或是文件連結,但支援Sample案例資源的

配置與匯入。這裡示範的package.json配置如下:

{
  "name": "com.test.test1",
  "displayName": "test1",
  "description": "This is test package",
  "version": "1.0.0",
  "unity": "2019.4",
  "unityRelease": "3f1",
  "author": {
    "name": "hont",
    "url": "your url"
  },
  "keywords": [
    "test"
  ],
  "type": "library",
    "samples": [
    {
      "displayName": "Sample1",
      "description": "This Sample1",
      "path": "Samples~/demo1"
    },
    {
      "displayName": "Sample2",
      "description": "This Sample2",
      "path": "Samples~/demo2"
    },
    {
      "displayName": "Sample3",
      "description": "This Sample3",
      "path": "Samples~/demo3"
    }
    ]
}

其具體規則在unity文件中可進行檢視,不多贅述。

 

最後新建ReadMe.md檔案,供網頁瀏覽git庫時檢視。

 

配置好之後其資料夾結構如下:

 

將Test1這個資料夾拿出來,把裡面的內容上傳至git倉庫即可,注意需要包含meta檔案。

 

上傳至git倉庫後,在Package Manager皮膚點選左上角加號,以新增git庫。

點選後即可匯入。

 

 

3.配置JSPWiki提供公共目錄頁

 

3.1 JSPWiki簡述

在資源上傳內網git後,由於不知道庫的地址及使用說明,

大家在使用時仍不太方便,這時我們可以使用JSPWiki這個簡單的Wiki工具來建立一個公共目錄頁,

並提供每一個庫的地址和說明。

 

JSPWiki的配置非常簡單,放入Tomcat即可執行,甚至不需要配置資料庫,且支援簡單的圖片上傳等功能。如下圖:

 

 

 3.2 安裝JSPWiki

這裡用到的環境為:

  • apache-tomcat-7.0.105
  • JSP Wiki 2.11.0.M3

 

先去JSP Wiki官網下載war包:

https://jspwiki-wiki.apache.org/

2.11.0 M3映象地址:

https://archive.apache.org/dist/jspwiki/2.11.0.M3/

一路點進/binaries/webapp/JSPWiki.war下載即可。

 

然後進行tomcat的安裝,下載地址:

https://tomcat.apache.org/download-70.cgi

解壓後需要配置環境變數到對應路徑,並且需要安裝對應版本JDK。

具體教程資源在網路上較多,不多說明。如果內網伺服器已經有tomcat就方便多了。

執行bin/startup.bat即可啟動tomcat,預設埠為8080,即:

http://127.0.0.1:8080/

測試後若開啟了tomcat的預設網頁即為安裝成功。

 

tomcat執行介面截圖:

 

將JSPWiki.war放入tomcat的webapps目錄內,再次執行tomcat即可自動解壓。

再去根據webapps的資料夾名進行訪問,例如:

http://127.0.0.1:8080/JSPWiki/

可進入JSPWiki的初始介面。

 

這樣就安裝好了。

 

3.3 配置管理員許可權

如果沒有管理員許可權則無法對附件、Wiki頁等進行刪除操作。

安裝JSPWiki後預設會生成一個管理員賬號,密碼隨機。但是有時候也不一定會跳出這個配置頁面,

此時可通過修改xml檔案來強行設定管理員。

 

首先點選右上角登入,新建一個賬號:

 

這裡以新賬號test1為例,進入JSPWiki\WEB-INF目錄。開啟groupdatabase.xml修改為:

<?xml version="1.0" encoding="UTF-8"?>
<groups>
  <group name="Admin" creator="hont" created="2020.08.09 at 09:55:04:612 GMT+08:00" modifier="hont" lastModified="2020.08.09 at 09:55:04:612 GMT+08:00">
    <member principal="test1" />
  </group>
</groups>

即可將test1加入管理員使用者組。

 

3.4 編寫wiki

我們可以通過直接訪問需要的目錄頁來編寫wiki,例如:

http://127.0.0.1:8081/JSPWiki/Wiki.jsp?page=Lib_InputSystem

此時會提示目錄頁不存在,點選建立即可。

 

編輯時點選編輯器的水滴圖示可進行加粗、插入圖片等常規操作:

 

也有類似md的語法,基礎格式語法如下:

----             水平線
//               換行符<BR>
[link]           插入超連結"link", "link"可以是一個內部Wiki名或者是一個外部連結(http://)
[text|link]      建立一個超連結, 連結採用text的描述進行顯示.
[text|wiki:link] 建立一個超連結, 連結採用text的描述進行顯示,並且連結指向一個內部Wiki名.
[attached_image] 用來嵌入一個圖片。前題是這個圖片要先作為附件上傳。"attached_image"代表這個附件圖片名.
*                建立一個專案列表. 如果是多個(**)符號,代表下一層次的縮排專案列表.
#                建立一個編號專案列表. 可以多層次(##, ###)縮排.
!, !!, !!!       用一個感嘆號(!)開頭的行可以表示一個標題. 多個感嘆號代表更大的標題
__text__         使文字text為粗體.
''text''         使文字text為斜體(注意是採用兩個單引號)
{{text}}         使文字text為等寬字型.
;term:def        用'def'定義一個條目'term'.  Use this with empty 'term' to make short comments.
|text|more text| 建立一個表格. 如果是表頭則採用雙豎線.

 

通過右上角資訊選項下的附件按鈕,可以插入圖片或其他一些內容:

再對圖片的URL進行引用,即可在wiki中使用圖片。

 

需要注意上傳圖片不能為中文,如果要上傳帶中文的圖片需要修改tomcat中

server.xml的標籤,加入URIEncoding="UTF-8":

<Connector port="8081" protocol="HTTP/1.1"
    connectionTimeout="20000"
    redirectPort="8443" URIEncoding="UTF-8" />

 

 

3.5 wiki資源的存放路徑

如果不進行配置wiki資源預設存放於:C:\Users\[your user name]\jspwiki-files內。

存放格式為txt,易於刪除、備份和修改。

 

相關文章