支持SC3(scx)脚本导出导入；支持文件夹脚本的导出

Author: wetor

README.md

@@ -3,15 +3,21 @@
 目标是完成尽可能通用的Mages工具集，目前仅以脚本为主
 
 ## 适配游戏
-- 《Chaos;Child》
-- 其他未测，理论都支持
+- 理论支持所有Mages引擎的游戏
+- 所有的MES(msb)、SC3(scx)脚本都可正常导出导入
 
 ## Usage
 ```
   -charset string
         [script.optional] Character set containing only text. Must be utf8 encoding. Choose between "charset" and "tbl"
+  -debug int
+        [optional] Debug level
+            0: Disable debug mode
+            1: Show info message
+            2: Show warning message (For example, the character table is missing characters)
+            3: Not implemented
   -export
-        [optional] Export mode
+        [optional] Export mode. Support folder export
   -format string
         [script.required] Format of script export and import. Case insensitive
             NPCSManager format: "Npcs"
@@ -21,11 +27,11 @@
   -input string
         [optional] Usually the import mode requires
   -output string
-        [required] Output file
+        [required] Output file or folder
   -skip
-        [script.optional] Skip duplicate code table characters. (default true)
+        [script.optional] Skip repeated characters in the character table. (default true)
   -source string
-        [required] Source file
+        [required] Source files or folder
   -tbl string
         [script.optional] Text in TBL format. Must be utf8 encoding. Choose between "charset" and "tbl"
   -type string
@@ -34,11 +40,20 @@
                 Now only MES format scripts are supported
             Diff Binary File: "diff"
                 Diff input and output file
-        
+
 
 ```
+### Example
 
 ```shell
+# 导出文件夹所有，使用tbl码表，格式为NpcsP，不跳过码表中相同字符，开启debug模式为2
+MagesTools -type=script -export -skip=false -debug=2\
+  -format=NpcsP \
+  -tbl=./data/CC/MJPN.txt \
+  -source=./data/CC/script/mes00 \
+  -output=./data/CC/txt
+
+
 # 导出文本，使用tbl码表，格式为NpcsP，跳过码表中相同字符
 MagesTools -type=script -export -skip=true \
   -format=NpcsP \
@@ -105,11 +120,16 @@ MagesTools -type=diff \
 ```
 
 ## 计划
-- SC3文本导出
-- ~~MES和~~SC3文本导入
+- 支持更多格式
 
 ## 更新日志
 
+### 2022.3.21
+- 支持SC3(scx)脚本的文本导入导出
+- 支持文件夹导出（暂不支持导入）
+- 增加简单的log
+- 优化代码细节
+
 ### 2022.3.20 2
 - 重构代码结构以支持更多导出格式
 - 支持NPCSManager格式的导出与导入

main.go

@@ -7,38 +7,48 @@ import (
 	"flag"
 	"fmt"
 	"github.com/go-restruct/restruct"
+	"path"
 	"strings"
 )
 
 func main() {
 
 	var pType, pSource, pInput, pOutput, pScriptFormat, pCharset, pTbl string
 	var pImport, pExport, pSkipChar bool
+	var pDebug int
 	flag.StringVar(&pType, "type", "", `[required] Source file type.
     MES(msb) Script: "script"
         Now only MES format scripts are supported
     Diff Binary File: "diff"
         Diff input and output file
 `)
-	flag.BoolVar(&pExport, "export", false, "[optional] Export mode")
+	flag.BoolVar(&pExport, "export", false, "[optional] Export mode. Support folder export")
 	flag.BoolVar(&pImport, "import", false, "[optional] Import mode")
+	flag.IntVar(&pDebug, "debug", 0, `[optional] Debug level
+    0: Disable debug mode
+    1: Show info message
+    2: Show warning message (For example, the character table is missing characters)
+    3: Not implemented`)
 
-	flag.StringVar(&pSource, "source", "", `[required] Source file`)
+	flag.StringVar(&pSource, "source", "", `[required] Source files or folder`)
 
 	flag.StringVar(&pInput, "input", "", `[optional] Usually the import mode requires`)
-	flag.StringVar(&pOutput, "output", "", `[required] Output file`)
+	flag.StringVar(&pOutput, "output", "", `[required] Output file or folder`)
 
 	flag.StringVar(&pScriptFormat, "format", "Npcs", `[script.required] Format of script export and import. Case insensitive
     NPCSManager format: "Npcs"
     NPCSManager Plus format: "NpcsP"`)
 	flag.StringVar(&pCharset, "charset", "", `[script.optional] Character set containing only text. Must be utf8 encoding. Choose between "charset" and "tbl"`)
 	flag.StringVar(&pTbl, "tbl", "", `[script.optional] Text in TBL format. Must be utf8 encoding. Choose between "charset" and "tbl"`)
 
-	flag.BoolVar(&pSkipChar, "skip", true, "[script.optional] Skip duplicate code table characters.")
+	flag.BoolVar(&pSkipChar, "skip", true, "[script.optional] Skip repeated characters in the character table.")
 
 	flag.Parse()
 	restruct.EnableExprBeta()
 
+	if pDebug >= 2 {
+		utils.ShowWarning = true
+	}
 	switch pType {
 	case "diff":
 		if len(pInput) == 0 && len(pOutput) == 0 {
@@ -53,7 +63,7 @@ func main() {
 			panic("必须指定export模式或import模式")
 		}
 		if len(pSource) == 0 {
-			panic("必须指定source源文件")
+			panic("必须指定source源文件或文件夹")
 		}
 
 		var _format format.Format
@@ -65,7 +75,7 @@ func main() {
 		default:
 			panic("未知脚本导出格式")
 		}
-		scr := script.OpenScript(pSource, _format)
+		scr := &script.Script{}
 
 		if len(pCharset) > 0 {
 			scr.LoadCharset(pCharset, false, pSkipChar)
@@ -74,14 +84,29 @@ func main() {
 		} else {
 			panic("必须指定charset文件或tbl文件")
 		}
-		scr.Read()
+
 		if pExport {
-			if len(pOutput) > 0 {
+			if utils.IsDir(pSource) && utils.IsDir(pOutput) {
+				files, _ := utils.GetDirFileList(pSource)
+				for _, file := range files {
+					if pDebug >= 1 {
+						fmt.Println(file)
+					}
+					scr.Open(file, _format)
+					scr.Read()
+					// 导出
+					scr.SaveStrings(path.Join(pOutput, path.Base(file)+".txt"))
+				}
+			} else if utils.IsFile(pSource) && utils.IsFile(pOutput) {
+				scr.Open(pSource, _format)
+				scr.Read()
 				scr.SaveStrings(pOutput)
 			} else {
-				panic("必须指定output文件")
+				panic("source和output必须同为文件，或同为文件夹")
 			}
 		} else if pImport {
+			scr.Open(pSource, _format)
+			scr.Read()
 			if len(pInput) > 0 {
 				scr.LoadStrings(pInput)
 			} else {

script/format/NpcsFormat.go

@@ -138,6 +138,9 @@ func (f *Npcs) DecodeLine(data []byte) string {
 					text.WriteString(char)
 				}
 			} else {
+				if utils.ShowWarning && data[i] > 0x80 {
+					fmt.Printf("Warning: 字库可能缺少 [%02X %02X] 对应的字符！\n", data[i], data[i+1])
+				}
 				if inName {
 					name += utils.FormatBytes(data[i : i+2])
 				} else {

script/format/NpcsPFormat.go

@@ -3,6 +3,7 @@ package format
 import (
 	"MagesTools/script/utils"
 	"bytes"
+	"fmt"
 	"strings"
 )
 
@@ -127,6 +128,9 @@ func (f *NpcsP) DecodeLine(data []byte) string {
 			if char, has := f.decodeCharset[index]; has {
 				text.WriteString(char)
 			} else {
+				if utils.ShowWarning && data[i] >= 0x80 {
+					fmt.Printf("Warning: 字库可能缺少 [%02X %02X] 对应的字符！\n", data[i], data[i+1])
+				}
 				text.WriteString(utils.FormatBytes(data[i : i+2]))
 			}
 			i += 2

script/mes.go

@@ -63,6 +63,9 @@ func (m *Mes) SetStrings(strings []string) {
 }
 
 func (m *Mes) WriteStrings(writeString func(string) []byte) {
+	if m.Count == 0 {
+		return
+	}
 	data := bytes.NewBuffer(nil)
 
 	offset := 0

script/mes_test.go

@@ -1,12 +1,10 @@
 package script
 
 import (
-	"encoding/hex"
 	"fmt"
 	"github.com/go-restruct/restruct"
 	"io"
 	"os"
-	"strings"
 	"testing"
 )
 
@@ -21,13 +19,3 @@ func TestLoadMes(t *testing.T) {
 		return ""
 	})
 }
-
-func Test001(t *testing.T) {
-	src := []byte{1, 0, 123, 44}
-	encodedStr := hex.EncodeToString(src)
-	encodedStr = strings.ToUpper(encodedStr)
-	fmt.Println(encodedStr)
-
-	test, _ := hex.DecodeString(encodedStr)
-	fmt.Println(test)
-}

script/sc3.go

@@ -0,0 +1,93 @@
+package script
+
+import (
+	"MagesTools/script/utils"
+	"bytes"
+	"encoding/binary"
+	"fmt"
+	"github.com/go-restruct/restruct"
+)
+
+type Sc3 struct {
+	Magic       string   `struct:"[4]byte"`
+	OffsetStart int      `struct:"int32"`
+	OffsetEnd   int      `struct:"int32"`
+	Count       int      `struct:"-"`
+	Offsets     []Entry  `struct:"-"`
+	Strings     []string `struct:"-"`
+	Raw         []byte   `struct:"-"`
+}
+
+func LoadSc3(data []byte) *Sc3 {
+	sc3 := &Sc3{
+		Raw: data,
+	}
+	return sc3
+}
+
+func (s *Sc3) ReadStrings(readString func([]byte) string) {
+	// 读取offset
+
+	err := restruct.Unpack(s.Raw, binary.LittleEndian, s)
+	if err != nil {
+		panic(err)
+	}
+	s.Count = (s.OffsetEnd - s.OffsetStart) / 4
+	s.Offsets = make([]Entry, s.Count)
+	offset := s.OffsetStart
+	for i := 0; i < s.Count; i++ {
+		s.Offsets[i].Offset = int(utils.BytesToUint32(s.Raw[offset : offset+4]))
+		offset += 4
+		if i >= 1 {
+			s.Offsets[i-1].Length = s.Offsets[i].Offset - s.Offsets[i-1].Offset
+		}
+	}
+	s.Offsets[s.Count-1].Length = len(s.Raw) - s.Offsets[s.Count-1].Offset
+
+	// 读取文本
+	s.Strings = make([]string, s.Count)
+	for i, offset := range s.Offsets {
+		s.Strings[i] = readString(s.Raw[offset.Offset : offset.Offset+offset.Length])
+	}
+
+}
+func (s *Sc3) GetStrings() []string {
+	return s.Strings
+}
+
+func (s *Sc3) SetStrings(strings []string) {
+	if s.Count != len(strings) {
+		panic(fmt.Sprintf("导入文本行数不匹配。原脚本：%d，导入：%d", s.Count, len(strings)))
+		return
+	}
+	s.Strings = strings
+
+}
+
+func (s *Sc3) WriteStrings(writeString func(string) []byte) {
+	if s.Count == 0 {
+		return
+	}
+	data := bytes.NewBuffer(nil) // 新文本段数据
+
+	offset := s.Offsets[0].Offset // 文本段开始
+	for i, str := range s.Strings {
+		line := writeString(str)
+		s.Offsets[i].Offset = offset
+		offset += len(line)
+
+		data.Write(line)
+	}
+	offset = s.Offsets[0].Offset           // 文本段开始
+	s.Raw = s.Raw[:offset]                 // 清除原文本段
+	s.Raw = append(s.Raw, data.Bytes()...) // 写入新文本段
+
+	offset = s.OffsetStart         // 偏移段开始
+	for i := 0; i < s.Count; i++ { // 写入新偏移段
+		copy(s.Raw[offset:offset+4], utils.Uint32ToBytes(uint32(s.Offsets[i].Offset)))
+		offset += 4
+	}
+}
+func (s *Sc3) GetRaw() []byte {
+	return s.Raw
+}

script/sc3_test.go

@@ -0,0 +1,21 @@
+package script
+
+import (
+	"fmt"
+	"github.com/go-restruct/restruct"
+	"io"
+	"os"
+	"testing"
+)
+
+func TestLoadSc3(t *testing.T) {
+	restruct.EnableExprBeta()
+	f, _ := os.Open("../data/CCLCC/script/claa01.scx")
+	defer f.Close()
+	data, _ := io.ReadAll(f)
+	mes := LoadSc3(data)
+	mes.ReadStrings(func(data []byte) string {
+		fmt.Println(data)
+		return ""
+	})
+}