Difference between revisions of "Agikit"
From AGI Wiki
Jump to navigationJump to search| Line 1: | Line 1: | ||
<div align="center" style="font-size: 22pt">agikit</div> | <div align="center" style="font-size: 22pt">agikit</div> | ||
| − | <div align="center">Version 0. | + | <div align="center">Version 0.8.0<br /> |
''Developer: [[Nat Budin]]''<br /> | ''Developer: [[Nat Budin]]''<br /> | ||
| − | [[2022|February | + | [[2022|February 19, 2022]]</div> |
{{AGISoftwareInfobox | {{AGISoftwareInfobox | ||
| Line 8: | Line 8: | ||
| image = [[Image:AgikitSS.png|190px]]<br /> | | image = [[Image:AgikitSS.png|190px]]<br /> | ||
''agikit Screenshot'' | ''agikit Screenshot'' | ||
| − | | Version = 0. | + | | Version = 0.8.0 |
| − | | ReleaseDate = [[2022|February | + | | ReleaseDate = [[2022|February 19, 2022]] |
| Company = | | Company = | ||
| Published = {{Published}} | | Published = {{Published}} | ||
| Line 48: | Line 48: | ||
* @agikit/cli command line utility: | * @agikit/cli command line utility: | ||
| − | ** Extract AGIv2 game resources | + | ** Extract AGIv2 and AGIv3 game resources |
| − | ** Build AGIv2 games from extracted resource directories and source | + | ** Build AGIv2 and AGIv3 games from extracted resource directories and source |
** Decompile and compile AGI LOGIC scripts | ** Decompile and compile AGI LOGIC scripts | ||
** Auto-format LOGIC scripts | ** Auto-format LOGIC scripts | ||
* @agikit/react-editors package: | * @agikit/react-editors package: | ||
** React components for editing VIEW and PIC resources | ** React components for editing VIEW and PIC resources | ||
| + | ** React component for viewing and playing IBM PCjr SOUND resources | ||
* agikit-vscode Visual Studio Code extension: | * agikit-vscode Visual Studio Code extension: | ||
** LOGIC language server with syntax highlighting, references support, document links, and more | ** LOGIC language server with syntax highlighting, references support, document links, and more | ||
** Build task for Visual Studio Code (to support one-click game builds) | ** 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 VIEW and PIC editors based on @agikit/react-editors | ||
| + | ** Custom SOUND viewer and player for IBM PCjr SOUND resources based on @agikit/react-editors | ||
==<br /> Version History == | ==<br /> 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.7: IBM PCjr SOUND decoding and playback, bug fixes for LOGIC editing, Node 17 compatibility | ||
* 0.6: VIEW decoding, encoding, and editing | * 0.6: VIEW decoding, encoding, and editing | ||
| Line 73: | Line 76: | ||
<blockquote> | <blockquote> | ||
| − | Active, but | + | Active, but early stage |
</blockquote> | </blockquote> | ||
| Line 89: | Line 92: | ||
==<br /> Known issues == | ==<br /> 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 | ||
==<br /> Credits == | ==<br /> Credits == | ||
* [[Nat Budin]] | * [[Nat Budin]] | ||
| − | * Uses code adapted from | + | * Uses code adapted from [[AGI Specifications]], [[QT AGI Studio]], and [[XV3]] |
==<br /> References == | ==<br /> References == | ||
Revision as of 14:41, 19 February 2022
agikit
| Latest Version: | 0.8.0 | ||
|---|---|---|---|
| Release Date: | February 19, 2022 | ||
| Company: | |||
| Publication Status: | Published | ||
| Developer(s): | Nat Budin | ||
| Interface: | {{{Interface}}} | ||
| Language: | TypeScript | ||
| Open Source: | Change to OpenSRC | ||
| Source Availability: | https://github.com/nbudin/agikit | ||
| License: | GPL | ||
| Platform: | Cross-Platform | ||
| Type: | AGI Development Tool | ||
| Localization: | English | ||
| Website: | https://github.com/nbudin/agikit | ||
Description
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
Active, but early stage
Usage
To get started in Visual Studio Code, follow the instructions in the project template's README.
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
- Nat Budin
- Uses code adapted from AGI Specifications, QT AGI Studio, and XV3
References
Also See
