Agikit: Difference between revisions
From Sierra Wiki
Jump to navigationJump to search
No edit summary |
No edit summary |
||
| (25 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
<div align="center"><span style="font-size: 22pt">agikit</span><br />''Version 0.8.3''<br />''Author: [[Nat Budin]]''<br />''2022-08-23''</div></div> | |||
<div align="center" style="font-size: 22pt">agikit</ | |||
{{FanAGISoftwareInfobox | {{FanAGISoftwareInfobox | ||
| Line 11: | Line 5: | ||
| Image = [[Image:AgikitSS.png|190px]]<br /> | | Image = [[Image:AgikitSS.png|190px]]<br /> | ||
''agikit Screenshot'' | ''agikit Screenshot'' | ||
| Version = 0.8. | | Version = 0.8.3 | ||
| ReleaseDate = [ | | ReleaseDate = {{2022S}}-08-23<ref>[https://github.com/nbudin/agikit https://github.com/nbudin/agikit]</ref> | ||
| | | Company = {{NAToolCo}} | ||
| DevStatus = {{MaintainedDev}} | |||
| Published = {{Published}} | | Published = {{Published}} | ||
| Developers = {{NatBudinToolDev}} | | Developers = {{NatBudinToolDev}} | ||
| Line 19: | Line 14: | ||
| ProgLanguage = {{TypeScript}} | | ProgLanguage = {{TypeScript}} | ||
| OpenSource = {{OpenSRC}} | | OpenSource = {{OpenSRC}} | ||
| Source = | | Source = [[github:nbudin/agikit Yes]] | ||
| License ={{GPL}} | | License ={{GPL}} | ||
| Platform = {{ | | Platform = {{CrossPlatTool}} | ||
| Type = {{ | | Type = {{AGIDevTool}} | ||
| Localization = {{ | | Engine = {{AGITool}} | ||
| Website = | | Platform = {{WinTool}} | ||
| Engine = {{AGITool}} | |||
| Localization = {{EnglishTool}} | |||
| Website = [[github:nbudin/agikit|nbudin/agikit]] | |||
}} | }} | ||
<br /> | <br /> | ||
== | ==<br /> Description == | ||
<blockquote> | <blockquote> | ||
agikit is a set of cross-platform development tools for AGI games. It aims to provide a composable, flexible platform for building AGI development tools from, and provides two tools of its own: a Visual Studio Code | [[Nat Budin]]'s agikit is a set of cross-platform development tools for AGI games. It aims to provide a composable, flexible platform for building AGI development tools from, and provides two tools of its own: a Visual Studio Code extension and a command-line tool. agikit was written by [[Nat Budin]]. | ||
extension and a command-line tool. agikit was written by [[Nat Budin]]. | |||
</blockquote> | </blockquote> | ||
===<br /> Screenshots === | ===<br /> Screenshots === | ||
<div align="center"> | |||
<gallery widths=320 heights=246 mode="nolines"> | |||
Image:AGIKitViewEditor.png|320px | |||
Image:AGIKitPICEditor.png|320px | |||
</gallery></div> | |||
==<br /> Features == | ==<br /> Features == | ||
| Line 75: | Line 71: | ||
<blockquote> | <blockquote> | ||
agikit is currently under development by [[Nat Budin]]. | |||
</blockquote> | </blockquote> | ||
| Line 82: | Line 78: | ||
To get started in Visual Studio Code, [https://github.com/nbudin/agikit-project-template follow the instructions in the project template's README]. | To get started in Visual Studio Code, [https://github.com/nbudin/agikit-project-template follow the instructions in the project template's README]. | ||
==<br /> Options == | |||
<blockquote> | |||
<!-- Add options here --> | |||
</blockquote> | |||
<div id="DL"> | |||
==<br /> Download == | ==<br /> Download == | ||
| Line 99: | Line 102: | ||
* [[Nat Budin]] | * [[Nat Budin]] | ||
<blockquote> | |||
===<br /> Acknowledgements === | |||
<blockquote> | |||
Uses code adapted from [[AGI Specifications]], [[QT AGI Studio]], and [[XV3]] | |||
</blockquote> | |||
</blockquote> | |||
==<br /> Legal == | |||
agikit was distributed with the {{GPL}} | |||
==<br /> References == | ==<br /> References == | ||
<references /> | <references /><!-- Do not edit this section. It is autopopulated by <ref></ref> tags --> | ||
==<br /> Also See == | ==<br /> Also See == | ||
* [[:Category:AGI Resources|AGI Resources]] | |||
* [[Volume File (AGI)|AGI Volume Files]] | |||
* [[AGI DIR File|AGI Directory File]] | |||
* [[Logic Resource (AGI)]] | |||
* [[AGI Specifications: Chapter 4 - The Logic Language|AGI Logic Language Specifications]] | |||
* [[:Category:Logic Resources|Logic Resource Articles]] | |||
* [[:Category:WORDS.TOK Articles|WORDS.TOK Articles]] | |||
* [[:Category:AGI Picture Resources|AGI Picture Resources]] | |||
* [[:Category:AGI View Resources|AGI View Resources]] | |||
* [[:Category:AGI Sound Resources|AGI Sound Resources]] | |||
* [[:Category:AGI Object File Articles|AGI Object File Articles]] | |||
* [[:Category:AGI Development Tools|AGI Development Tools]] | * [[:Category:AGI Development Tools|AGI Development Tools]] | ||
* [[:Category:AGI Dev Tools|AGI Dev Tools]] | |||
* [https://github.com/nbudin/agikit https://github.com/nbudin/agikit] | |||
| | ||
[[Category:Technical Info]] | [[Category:Technical Info]] | ||
[[Category:References]] | |||
[[Category:Development]] | |||
[[Category:AGI Development]] | |||
[[Category:Development Tools]] | [[Category:Development Tools]] | ||
[[Category:AGI Development Tools]] | [[Category:AGI Development Tools]] | ||
Latest revision as of 19:34, 29 October 2025
agikit Screenshot | |||
| Latest Version: | 0.8.3 | ||
|---|---|---|---|
| Release Date: | 2022-08-23[1] | ||
| Company: | N/A | ||
| Development Status: | Maintained | ||
| Publication Status: | Published | ||
| Developer(s): | Nat Budin | ||
| Interface: | GUI | ||
| Language: | TypeScript | ||
| Open Source: | Open | ||
| Source Availability: | github:nbudin/agikit Yes | ||
| License: | GPL | ||
| Type: | Development Tool | ||
| Relevant Engine: | AGI | ||
| Platform: | Windows | ||
| Localization: | English | ||
| Website: | nbudin/agikit | ||
Description
Nat Budin's agikit is a set of cross-platform development tools for AGI games. It aims to provide a composable, flexible platform for building AGI development tools from, and provides two tools of its own: a Visual Studio Code extension and a command-line tool. agikit was written by Nat Budin.
Screenshots
Features
- @agikit/cli command line utility:
- Extract AGIv2 and AGIv3 game resources
- Build AGIv2 and AGIv3 games from extracted resource directories and source
- Decompile and compile AGI LOGIC scripts
- Auto-format LOGIC scripts
- @agikit/react-editors package:
- React components for editing VIEW and PIC resources
- React component for viewing and playing IBM PCjr SOUND resources
- agikit-vscode Visual Studio Code extension:
- LOGIC language server with syntax highlighting, references support, document links, and more
- Build task for Visual Studio Code (to support one-click game builds)
- ScummVM "debug" task (to support running games from VSCode, but no actual debug support yet)
- Custom VIEW and PIC editors based on @agikit/react-editors
- Custom SOUND viewer and player for IBM PCjr SOUND resources based on @agikit/react-editors
Version History
- 0.8: AGIv3 support, project configuration file support, new PIC format, VSCode user experience improvements
- 0.7: IBM PCjr SOUND decoding and playback, bug fixes for LOGIC editing, Node 17 compatibility
- 0.6: VIEW decoding, encoding, and editing
- 0.5: PIC decoding, encoding, and editing
- 0.4: First release with the Visual Studio Code extension
- 0.3: Full LOGIC syntax support
- 0.2: Extract OBJECT files, build OBJECT and WORDS.TOK
- 0.1: First release
Development Status
agikit is currently under development by Nat Budin.
Usage
To get started in Visual Studio Code, follow the instructions in the project template's README.
Options
Download
agikit itself: https://github.com/nbudin/agikit
A template project for getting started with agikit: https://github.com/nbudin/agikit-project-template
Known issues
- SOUND editing is incomplete and only supports IBM PCjr SOUND resources
- Not yet compatible with WinAGI projects
- There are some missing features in the LOGIC language:
- `]` as a comment character
Credits
AcknowledgementsUses code adapted from AGI Specifications, QT AGI Studio, and XV3
Legal
agikit was distributed with the GPL
References
Also See
- AGI Resources
- AGI Volume Files
- AGI Directory File
- Logic Resource (AGI)
- AGI Logic Language Specifications
- Logic Resource Articles
- WORDS.TOK Articles
- AGI Picture Resources
- AGI View Resources
- AGI Sound Resources
- AGI Object File Articles
- AGI Development Tools
- AGI Dev Tools
- https://github.com/nbudin/agikit