feature(docs): update readme & year (#182)

xensik · Jan 14, 2024 · bef0355 · bef0355
1 parent 9b885e3
commit bef0355
Show file tree

Hide file tree

Showing 204 changed files with 226 additions and 223 deletions.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
diff --git a/README.md b/README.md
@@ -24,18 +24,27 @@ A utility to compile & decompile IW engine game scripts.
 - **T9** *(Call of Duty: Black Ops Cold War)* ***\*WIP\****
 
 ## Usage
-``./gsc-tool.exe <mode> <game> <system> <path>``
+``gsc-tool [OPTIONS..] <path>``
 
-**mode**: `asm`, `disasm`, `comp`, `decomp`, `parse`
-- *note:* zonetool files (*.cgsc*, *.cgsc.stack*) use: `zasm`, `zdisasm`, `zcomp`, `zdecomp` modes
+- **path**: file or directory to process
 
-**game**: `iw5`, `iw6`, `iw7`, `iw8`, `iw9`, `s1`, `s2`, `s4`, `h1`, `h2`, `t6` `t7` `t8` `t9`
+- **options:**
 
-**system**: `pc`, `ps3`, `ps4`, `ps5`, `xb2` (*360*), `xb3` (*One*), `xb4` (*Series X|S*), `wiiu`
+    ``-m, --mode <mode>``  [REQUIRED] one of: `asm`, `disasm`, `comp`, `decomp`, `parse`
 
-**path**: `file` or `directory` (recursive process all files inside the directory)
+    ``-g, --game <game>`` [REQUIRED] one of: `iw5`, `iw6`, `iw7`, `iw8`, `iw9`, `s1`, `s2`, `s4`, `h1`, `h2`, `t6` `t7` `t8` `t9`
 
-Example: ``./gsc-tool.exe comp iw5 pc ./data/iw5/my_fancy_script.gsc``
+    ``-s, --system <system>`` [REQUIRED] one of: `pc`, `ps3`, `ps4`, `ps5`, `xb2` (*360*), `xb3` (*One*), `xb4` (*Series X|S*), `wiiu`
+
+    ``-d, --dev`` Enable developer mode (generate bytecode map).
+
+    ``-z, --zonetool`` Enable zonetool mode (use .cgsc files).
+
+    ``-h, --help`` Display help.
+
+    ``-v, --version`` Display version.
+
+Example: ``gsc-tool -m comp -g iw5 -s pc ./data/iw5/my_fancy_script.gsc``
 
 | Mode     |Description                | Output      |
 |:---------|:--------------------------|:------------|
@@ -48,13 +57,14 @@ Example: ``./gsc-tool.exe comp iw5 pc ./data/iw5/my_fancy_script.gsc``
 ## File Format
 If you need to extract scripts from fastfiles or game memory, use [Zonetool](https://github.com/ZoneTool/zonetool) or [Jekyll](https://github.com/EthanC/Jekyll).
 
-- gsc-tool `.gscbin` format is a serialized ScriptFile struct: <br/>
-***name***: null-terminated string <br/>
-***compressedLen***: 4 byte uint <br/>
-***len***: 4 byte uint <br/>
-***bytecodeLen***: 4 byte uint <br/>
-***buffer***: byte array[compressedLen] <br/>
-***bytecode***: byte array[bytecodeLen] <br/>
+- gsc-tool `.gscbin` binary format is a serialized ScriptFile struct: <br/>
+
+  - ***magic***: `"GSC\0"` 4 byte <br/>
+  - ***compressedLen***: 4 byte usigned integer <br/>
+  - ***len***: 4 byte usigned integer <br/>
+  - ***bytecodeLen***: 4 byte usigned integer <br/>
+  - ***buffer***: byte array[compressedLen] <br/>
+  - ***bytecode***: byte array[bytecodeLen] <br/>
 
 note: for PS3 & Xbox 360 `.gscbin` files *(compressedLen, len, bytecodeLen)* are saved as little-endian!!
 

diff --git a/gen/arc/parser.ypp b/gen/arc/parser.ypp
@@ -1,4 +1,4 @@
-/* Copyright 2023 xensik. All rights reserved.
+/* Copyright 2024 xensik. All rights reserved.
 //
 // Use of this source code is governed by a GNU GPLv3 license
 // that can be found in the LICENSE file.

diff --git a/gen/gsc/parser.ypp b/gen/gsc/parser.ypp
@@ -1,4 +1,4 @@
-/* Copyright 2023 xensik. All rights reserved.
+/* Copyright 2024 xensik. All rights reserved.
 //
 // Use of this source code is governed by a GNU GPLv3 license
 // that can be found in the LICENSE file.

diff --git a/include/xsk/arc/assembler.hpp b/include/xsk/arc/assembler.hpp
@@ -1,4 +1,4 @@
-// Copyright 2023 xensik. All rights reserved.
+// Copyright 2024 xensik. All rights reserved.
 //
 // Use of this source code is governed by a GNU GPLv3 license
 // that can be found in the LICENSE file.

diff --git a/include/xsk/arc/common/assembly.hpp b/include/xsk/arc/common/assembly.hpp
@@ -1,4 +1,4 @@
-// Copyright 2023 xensik. All rights reserved.
+// Copyright 2024 xensik. All rights reserved.
 //
 // Use of this source code is governed by a GNU GPLv3 license
 // that can be found in the LICENSE file.

diff --git a/include/xsk/arc/common/asset.hpp b/include/xsk/arc/common/asset.hpp
@@ -1,4 +1,4 @@
-// Copyright 2023 xensik. All rights reserved.
+// Copyright 2024 xensik. All rights reserved.
 //
 // Use of this source code is governed by a GNU GPLv3 license
 // that can be found in the LICENSE file.

diff --git a/include/xsk/arc/common/ast.hpp b/include/xsk/arc/common/ast.hpp
@@ -1,4 +1,4 @@
-// Copyright 2023 xensik. All rights reserved.
+// Copyright 2024 xensik. All rights reserved.
 //
 // Use of this source code is governed by a GNU GPLv3 license
 // that can be found in the LICENSE file.

diff --git a/include/xsk/arc/common/buffer.hpp b/include/xsk/arc/common/buffer.hpp
@@ -1,4 +1,4 @@
-// Copyright 2023 xensik. All rights reserved.
+// Copyright 2024 xensik. All rights reserved.
 //
 // Use of this source code is governed by a GNU GPLv3 license
 // that can be found in the LICENSE file.

diff --git a/include/xsk/arc/common/define.hpp b/include/xsk/arc/common/define.hpp
@@ -1,4 +1,4 @@
-// Copyright 2023 xensik. All rights reserved.
+// Copyright 2024 xensik. All rights reserved.
 //
 // Use of this source code is governed by a GNU GPLv3 license
 // that can be found in the LICENSE file.

diff --git a/include/xsk/arc/common/directive.hpp b/include/xsk/arc/common/directive.hpp
@@ -1,4 +1,4 @@
-// Copyright 2023 xensik. All rights reserved.
+// Copyright 2024 xensik. All rights reserved.
 //
 // Use of this source code is governed by a GNU GPLv3 license
 // that can be found in the LICENSE file.

diff --git a/include/xsk/arc/common/exception.hpp b/include/xsk/arc/common/exception.hpp
@@ -1,4 +1,4 @@
-// Copyright 2023 xensik. All rights reserved.
+// Copyright 2024 xensik. All rights reserved.
 //
 // Use of this source code is governed by a GNU GPLv3 license
 // that can be found in the LICENSE file.

diff --git a/include/xsk/arc/common/location.hpp b/include/xsk/arc/common/location.hpp
@@ -1,4 +1,4 @@
-// Copyright 2023 xensik. All rights reserved.
+// Copyright 2024 xensik. All rights reserved.
 //
 // Use of this source code is governed by a GNU GPLv3 license
 // that can be found in the LICENSE file.

diff --git a/include/xsk/arc/common/lookahead.hpp b/include/xsk/arc/common/lookahead.hpp
@@ -1,4 +1,4 @@
-// Copyright 2023 xensik. All rights reserved.
+// Copyright 2024 xensik. All rights reserved.
 //
 // Use of this source code is governed by a GNU GPLv3 license
 // that can be found in the LICENSE file.

diff --git a/include/xsk/arc/common/scope.hpp b/include/xsk/arc/common/scope.hpp
@@ -1,4 +1,4 @@
-// Copyright 2023 xensik. All rights reserved.
+// Copyright 2024 xensik. All rights reserved.
 //
 // Use of this source code is governed by a GNU GPLv3 license
 // that can be found in the LICENSE file.

diff --git a/include/xsk/arc/common/space.hpp b/include/xsk/arc/common/space.hpp
@@ -1,4 +1,4 @@
-// Copyright 2023 xensik. All rights reserved.
+// Copyright 2024 xensik. All rights reserved.
 //
 // Use of this source code is governed by a GNU GPLv3 license
 // that can be found in the LICENSE file.

diff --git a/include/xsk/arc/common/token.hpp b/include/xsk/arc/common/token.hpp
@@ -1,4 +1,4 @@
-// Copyright 2023 xensik. All rights reserved.
+// Copyright 2024 xensik. All rights reserved.
 //
 // Use of this source code is governed by a GNU GPLv3 license
 // that can be found in the LICENSE file.

diff --git a/include/xsk/arc/common/types.hpp b/include/xsk/arc/common/types.hpp
@@ -1,4 +1,4 @@
-// Copyright 2023 xensik. All rights reserved.
+// Copyright 2024 xensik. All rights reserved.
 //
 // Use of this source code is governed by a GNU GPLv3 license
 // that can be found in the LICENSE file.

diff --git a/include/xsk/arc/compiler.hpp b/include/xsk/arc/compiler.hpp
@@ -1,4 +1,4 @@
-// Copyright 2023 xensik. All rights reserved.
+// Copyright 2024 xensik. All rights reserved.
 //
 // Use of this source code is governed by a GNU GPLv3 license
 // that can be found in the LICENSE file.

diff --git a/include/xsk/arc/context.hpp b/include/xsk/arc/context.hpp
@@ -1,4 +1,4 @@
-// Copyright 2023 xensik. All rights reserved.
+// Copyright 2024 xensik. All rights reserved.
 //
 // Use of this source code is governed by a GNU GPLv3 license
 // that can be found in the LICENSE file.

diff --git a/include/xsk/arc/decompiler.hpp b/include/xsk/arc/decompiler.hpp
@@ -1,4 +1,4 @@
-// Copyright 2023 xensik. All rights reserved.
+// Copyright 2024 xensik. All rights reserved.
 //
 // Use of this source code is governed by a GNU GPLv3 license
 // that can be found in the LICENSE file.

diff --git a/include/xsk/arc/disassembler.hpp b/include/xsk/arc/disassembler.hpp
@@ -1,4 +1,4 @@
-// Copyright 2023 xensik. All rights reserved.
+// Copyright 2024 xensik. All rights reserved.
 //
 // Use of this source code is governed by a GNU GPLv3 license
 // that can be found in the LICENSE file.

diff --git a/include/xsk/arc/engine/t6.hpp b/include/xsk/arc/engine/t6.hpp
@@ -1,4 +1,4 @@
-// Copyright 2023 xensik. All rights reserved.
+// Copyright 2024 xensik. All rights reserved.
 //
 // Use of this source code is governed by a GNU GPLv3 license
 // that can be found in the LICENSE file.

diff --git a/include/xsk/arc/engine/t6_pc.hpp b/include/xsk/arc/engine/t6_pc.hpp
@@ -1,4 +1,4 @@
-// Copyright 2023 xensik. All rights reserved.
+// Copyright 2024 xensik. All rights reserved.
 //
 // Use of this source code is governed by a GNU GPLv3 license
 // that can be found in the LICENSE file.

diff --git a/include/xsk/arc/engine/t6_ps3.hpp b/include/xsk/arc/engine/t6_ps3.hpp
@@ -1,4 +1,4 @@
-// Copyright 2023 xensik. All rights reserved.
+// Copyright 2024 xensik. All rights reserved.
 //
 // Use of this source code is governed by a GNU GPLv3 license
 // that can be found in the LICENSE file.

diff --git a/include/xsk/arc/engine/t6_wiiu.hpp b/include/xsk/arc/engine/t6_wiiu.hpp
@@ -1,4 +1,4 @@
-// Copyright 2023 xensik. All rights reserved.
+// Copyright 2024 xensik. All rights reserved.
 //
 // Use of this source code is governed by a GNU GPLv3 license
 // that can be found in the LICENSE file.

diff --git a/include/xsk/arc/engine/t6_xb2.hpp b/include/xsk/arc/engine/t6_xb2.hpp
@@ -1,4 +1,4 @@
-// Copyright 2023 xensik. All rights reserved.
+// Copyright 2024 xensik. All rights reserved.
 //
 // Use of this source code is governed by a GNU GPLv3 license
 // that can be found in the LICENSE file.

diff --git a/include/xsk/arc/engine/t7.hpp b/include/xsk/arc/engine/t7.hpp
@@ -1,4 +1,4 @@
-// Copyright 2023 xensik. All rights reserved.
+// Copyright 2024 xensik. All rights reserved.
 //
 // Use of this source code is governed by a GNU GPLv3 license
 // that can be found in the LICENSE file.

diff --git a/include/xsk/arc/engine/t8.hpp b/include/xsk/arc/engine/t8.hpp
@@ -1,4 +1,4 @@
-// Copyright 2023 xensik. All rights reserved.
+// Copyright 2024 xensik. All rights reserved.
 //
 // Use of this source code is governed by a GNU GPLv3 license
 // that can be found in the LICENSE file.

diff --git a/include/xsk/arc/engine/t9.hpp b/include/xsk/arc/engine/t9.hpp
@@ -1,4 +1,4 @@
-// Copyright 2023 xensik. All rights reserved.
+// Copyright 2024 xensik. All rights reserved.
 //
 // Use of this source code is governed by a GNU GPLv3 license
 // that can be found in the LICENSE file.

diff --git a/include/xsk/arc/lexer.hpp b/include/xsk/arc/lexer.hpp
@@ -1,4 +1,4 @@
-// Copyright 2023 xensik. All rights reserved.
+// Copyright 2024 xensik. All rights reserved.
 //
 // Use of this source code is governed by a GNU GPLv3 license
 // that can be found in the LICENSE file.

diff --git a/include/xsk/arc/preprocessor.hpp b/include/xsk/arc/preprocessor.hpp
@@ -1,4 +1,4 @@
-// Copyright 2023 xensik. All rights reserved.
+// Copyright 2024 xensik. All rights reserved.
 //
 // Use of this source code is governed by a GNU GPLv3 license
 // that can be found in the LICENSE file.

diff --git a/include/xsk/arc/source.hpp b/include/xsk/arc/source.hpp
@@ -1,4 +1,4 @@
-// Copyright 2023 xensik. All rights reserved.
+// Copyright 2024 xensik. All rights reserved.
 //
 // Use of this source code is governed by a GNU GPLv3 license
 // that can be found in the LICENSE file.

diff --git a/include/xsk/gsc/assembler.hpp b/include/xsk/gsc/assembler.hpp
@@ -1,4 +1,4 @@
-// Copyright 2023 xensik. All rights reserved.
+// Copyright 2024 xensik. All rights reserved.
 //
 // Use of this source code is governed by a GNU GPLv3 license
 // that can be found in the LICENSE file.

diff --git a/include/xsk/gsc/common/assembly.hpp b/include/xsk/gsc/common/assembly.hpp
@@ -1,4 +1,4 @@
-// Copyright 2023 xensik. All rights reserved.
+// Copyright 2024 xensik. All rights reserved.
 //
 // Use of this source code is governed by a GNU GPLv3 license
 // that can be found in the LICENSE file.

diff --git a/include/xsk/gsc/common/asset.hpp b/include/xsk/gsc/common/asset.hpp
@@ -1,4 +1,4 @@
-// Copyright 2023 xensik. All rights reserved.
+// Copyright 2024 xensik. All rights reserved.
 //
 // Use of this source code is governed by a GNU GPLv3 license
 // that can be found in the LICENSE file.

diff --git a/include/xsk/gsc/common/ast.hpp b/include/xsk/gsc/common/ast.hpp
@@ -1,4 +1,4 @@
-// Copyright 2023 xensik. All rights reserved.
+// Copyright 2024 xensik. All rights reserved.
 //
 // Use of this source code is governed by a GNU GPLv3 license
 // that can be found in the LICENSE file.

diff --git a/include/xsk/gsc/common/buffer.hpp b/include/xsk/gsc/common/buffer.hpp
@@ -1,4 +1,4 @@
-// Copyright 2023 xensik. All rights reserved.
+// Copyright 2024 xensik. All rights reserved.
 //
 // Use of this source code is governed by a GNU GPLv3 license
 // that can be found in the LICENSE file.

diff --git a/include/xsk/gsc/common/define.hpp b/include/xsk/gsc/common/define.hpp
@@ -1,4 +1,4 @@
-// Copyright 2023 xensik. All rights reserved.
+// Copyright 2024 xensik. All rights reserved.
 //
 // Use of this source code is governed by a GNU GPLv3 license
 // that can be found in the LICENSE file.

diff --git a/include/xsk/gsc/common/directive.hpp b/include/xsk/gsc/common/directive.hpp
@@ -1,4 +1,4 @@
-// Copyright 2023 xensik. All rights reserved.
+// Copyright 2024 xensik. All rights reserved.
 //
 // Use of this source code is governed by a GNU GPLv3 license
 // that can be found in the LICENSE file.

diff --git a/include/xsk/gsc/common/exception.hpp b/include/xsk/gsc/common/exception.hpp
@@ -1,4 +1,4 @@
-// Copyright 2023 xensik. All rights reserved.
+// Copyright 2024 xensik. All rights reserved.
 //
 // Use of this source code is governed by a GNU GPLv3 license
 // that can be found in the LICENSE file.

diff --git a/include/xsk/gsc/common/location.hpp b/include/xsk/gsc/common/location.hpp
@@ -1,4 +1,4 @@
-// Copyright 2023 xensik. All rights reserved.
+// Copyright 2024 xensik. All rights reserved.
 //
 // Use of this source code is governed by a GNU GPLv3 license
 // that can be found in the LICENSE file.

diff --git a/include/xsk/gsc/common/lookahead.hpp b/include/xsk/gsc/common/lookahead.hpp
@@ -1,4 +1,4 @@
-// Copyright 2023 xensik. All rights reserved.
+// Copyright 2024 xensik. All rights reserved.
 //
 // Use of this source code is governed by a GNU GPLv3 license
 // that can be found in the LICENSE file.

diff --git a/include/xsk/gsc/common/scope.hpp b/include/xsk/gsc/common/scope.hpp
@@ -1,4 +1,4 @@
-// Copyright 2023 xensik. All rights reserved.
+// Copyright 2024 xensik. All rights reserved.
 //
 // Use of this source code is governed by a GNU GPLv3 license
 // that can be found in the LICENSE file.

diff --git a/include/xsk/gsc/common/space.hpp b/include/xsk/gsc/common/space.hpp
@@ -1,4 +1,4 @@
-// Copyright 2023 xensik. All rights reserved.
+// Copyright 2024 xensik. All rights reserved.
 //
 // Use of this source code is governed by a GNU GPLv3 license
 // that can be found in the LICENSE file.

diff --git a/include/xsk/gsc/common/token.hpp b/include/xsk/gsc/common/token.hpp
@@ -1,4 +1,4 @@
-// Copyright 2023 xensik. All rights reserved.
+// Copyright 2024 xensik. All rights reserved.
 //
 // Use of this source code is governed by a GNU GPLv3 license
 // that can be found in the LICENSE file.

diff --git a/include/xsk/gsc/common/types.hpp b/include/xsk/gsc/common/types.hpp
@@ -1,4 +1,4 @@
-// Copyright 2023 xensik. All rights reserved.
+// Copyright 2024 xensik. All rights reserved.
 //
 // Use of this source code is governed by a GNU GPLv3 license
 // that can be found in the LICENSE file.

diff --git a/include/xsk/gsc/compiler.hpp b/include/xsk/gsc/compiler.hpp
@@ -1,4 +1,4 @@
-// Copyright 2023 xensik. All rights reserved.
+// Copyright 2024 xensik. All rights reserved.
 //
 // Use of this source code is governed by a GNU GPLv3 license
 // that can be found in the LICENSE file.

diff --git a/include/xsk/gsc/context.hpp b/include/xsk/gsc/context.hpp
@@ -1,4 +1,4 @@
-// Copyright 2023 xensik. All rights reserved.
+// Copyright 2024 xensik. All rights reserved.
 //
 // Use of this source code is governed by a GNU GPLv3 license
 // that can be found in the LICENSE file.

diff --git a/include/xsk/gsc/decompiler.hpp b/include/xsk/gsc/decompiler.hpp
@@ -1,4 +1,4 @@
-// Copyright 2023 xensik. All rights reserved.
+// Copyright 2024 xensik. All rights reserved.
 //
 // Use of this source code is governed by a GNU GPLv3 license
 // that can be found in the LICENSE file.

diff --git a/include/xsk/gsc/disassembler.hpp b/include/xsk/gsc/disassembler.hpp
@@ -1,4 +1,4 @@
-// Copyright 2023 xensik. All rights reserved.
+// Copyright 2024 xensik. All rights reserved.
 //
 // Use of this source code is governed by a GNU GPLv3 license
 // that can be found in the LICENSE file.

diff --git a/include/xsk/gsc/engine/h1.hpp b/include/xsk/gsc/engine/h1.hpp
@@ -1,4 +1,4 @@
-// Copyright 2023 xensik. All rights reserved.
+// Copyright 2024 xensik. All rights reserved.
 //
 // Use of this source code is governed by a GNU GPLv3 license
 // that can be found in the LICENSE file.

diff --git a/include/xsk/gsc/engine/h2.hpp b/include/xsk/gsc/engine/h2.hpp
@@ -1,4 +1,4 @@
-// Copyright 2023 xensik. All rights reserved.
+// Copyright 2024 xensik. All rights reserved.
 //
 // Use of this source code is governed by a GNU GPLv3 license
 // that can be found in the LICENSE file.

diff --git a/include/xsk/gsc/engine/iw5_pc.hpp b/include/xsk/gsc/engine/iw5_pc.hpp
@@ -1,4 +1,4 @@
-// Copyright 2023 xensik. All rights reserved.
+// Copyright 2024 xensik. All rights reserved.
 //
 // Use of this source code is governed by a GNU GPLv3 license
 // that can be found in the LICENSE file.

diff --git a/include/xsk/gsc/engine/iw5_ps.hpp b/include/xsk/gsc/engine/iw5_ps.hpp
@@ -1,4 +1,4 @@
-// Copyright 2023 xensik. All rights reserved.
+// Copyright 2024 xensik. All rights reserved.
 //
 // Use of this source code is governed by a GNU GPLv3 license
 // that can be found in the LICENSE file.

diff --git a/include/xsk/gsc/engine/iw5_xb.hpp b/include/xsk/gsc/engine/iw5_xb.hpp
@@ -1,4 +1,4 @@
-// Copyright 2023 xensik. All rights reserved.
+// Copyright 2024 xensik. All rights reserved.
 //
 // Use of this source code is governed by a GNU GPLv3 license
 // that can be found in the LICENSE file.

diff --git a/include/xsk/gsc/engine/iw6_pc.hpp b/include/xsk/gsc/engine/iw6_pc.hpp
@@ -1,4 +1,4 @@
-// Copyright 2023 xensik. All rights reserved.
+// Copyright 2024 xensik. All rights reserved.
 //
 // Use of this source code is governed by a GNU GPLv3 license
 // that can be found in the LICENSE file.