Difference between revisions of "Agikit"

From AGI Wiki
Jump to navigationJump to search
(Created page with "<div align="center" style="font-size: 22pt">Agikit</div> <div align="center">Version 0.4<br /> ''Author: Nat Budin''<br /> March 10, 2021</div> {{AGISoftwareInfobox |...")
 
 
(27 intermediate revisions by 2 users not shown)
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.4<br />
+
<div align="center">Version 0.8.0<br />
−
''Author: [[Nat Budin]]''<br />
+
''Developer: [[Nat Budin]]''<br />
−
[[March 10, 2021]]</div>
+
[[2022|February 19, 2022]]</div>
  
−
{{AGISoftwareInfobox
+
{{FanAGISoftwareInfobox
−
| Software = Agikit
+
| Software = agikit
−
| image = [[Image:AgikitSS.png|190px]]<br />
+
| Image = [[Image:AgikitSS.png|190px]]<br />
−
''Agikit Screenshot''
+
''agikit Screenshot''
−
| Version = 0.4
+
| Version = 0.8.0
−
| ReleaseDate = [[March 10, 2021]]
+
| ReleaseDate = [[2022|February 19, 2022]]
 
| Company =  
 
| Company =  
 
| Published = {{Published}}
 
| Published = {{Published}}
 
| Developers = {{NatBudinToolDev}}
 
| Developers = {{NatBudinToolDev}}
−
| ProgLanguage = {{Unknown}}
+
| Interface = {{GUI}}
 +
| ProgLanguage = {{TypeScript}}
 
| OpenSource = {{Open}}
 
| OpenSource = {{Open}}
−
| Source = {{SourceSW}}
+
| Source = https://github.com/nbudin/agikit
−
| License = {{NoLicense}}
+
| License ={{GPL}}
−
| Platform = {{UnknownTool}}
+
| Platform = {{CrossPlat}}
 
| Type = {{AGIDevTool}}
 
| Type = {{AGIDevTool}}
 
| Localization = {{EnglishTool}}
 
| Localization = {{EnglishTool}}
−
| Website =  
+
| Website = https://github.com/nbudin/agikit
 
}}
 
}}
−
 
−
{{Stub}}
 
  
 
<br />
 
<br />
Line 29: Line 28:
  
 
<blockquote>
 
<blockquote>
−
[[Nat Budin]]'s  Agikit is
+
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]].
  
 
{{TechToDo}}
 
{{TechToDo}}
 
</blockquote>
 
</blockquote>
−
<!--
+
 
 
===<br /> Screenshots ===
 
===<br /> Screenshots ===
  
 
{| align="center" width="80%"
 
{| align="center" width="80%"
−
| align="center"|[[Image:AgikitSS1.png|320px]]
+
| align="center"|[[Image:AgikitSS.png]]
−
| align="center"|[[Image:AgikitSS2.png|320px]]
+
|}
 +
{| align="center" width="80%"
 +
| align="center"|[[Image:AGIKitViewEditor.png]]
 +
|}
 +
{| align="center" width="80%"
 +
| align="center"|[[Image:AGIKitPICEditor.png]]
 
|}
 
|}
−
-->
 
  
 
==<br /> Features ==
 
==<br /> 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
  
 
==<br /> Version History ==
 
==<br /> Version History ==
  
−
<blockquote>
+
* 0.8: AGIv3 support, project configuration file support, new PIC format, VSCode user experience improvements
−
&nbsp;<!-- Place version history here
+
* 0.7: IBM PCjr SOUND decoding and playback, bug fixes for LOGIC editing, Node 17 compatibility
−
<span class="Inactive">N/A</span> -->
+
* 0.6: VIEW decoding, encoding, and editing
−
</blockquote>
+
* 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
  
 
==<br /> Development Status ==
 
==<br /> Development Status ==
  
 
<blockquote>
 
<blockquote>
−
&nbsp;<!-- Place development status here
+
Active, but early stage
−
<span class="Inactive">N/A</span> -->
 
 
</blockquote>
 
</blockquote>
  
 
==<br /> Usage ==
 
==<br /> Usage ==
  
−
#
+
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>
 
−
&nbsp;
 
−
</blockquote>
 
  
 
==<br /> Download ==
 
==<br /> Download ==
  
 
<blockquote>
 
<blockquote>
−
Download from here:
+
agikit itself: https://github.com/nbudin/agikit<br/>
−
* <span class="Inactive">Not available at this time.</span>
+
A template project for getting started with agikit: https://github.com/nbudin/agikit-project-template
−
<!--
 
−
* [[File:ZIP.png|ZIP File]] [[File:|]]<span class="DLInfo"> (ZIP file) []</span>
 
−
-->
 
 
</blockquote>
 
</blockquote>
  
 
==<br /> Known issues ==
 
==<br /> Known issues ==
  
−
* None known
+
* 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 [[AGI Specifications]], [[QT AGI Studio]], and [[XV3]]
  
 
==<br /> References ==
 
==<br /> References ==

Latest revision as of 22:38, 23 June 2022

agikit
Version 0.8.0

Developer: Nat Budin

February 19, 2022
agikit
AgikitSS.png
agikit Screenshot
Latest Version:  0.8.0
Release Date:  February 19, 2022
Company:
Publication Status:  Published
Developer(s): Nat Budin
Interface: GUI
Language: TypeScript
Open Source: Open
Source Availability:  https://github.com/nbudin/agikit
License: GPL
Type: AGI Development Tool
Platform: Cross-Platform
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

AgikitSS.png
AGIKitViewEditor.png
AGIKitPICEditor.png


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


References



Also See

 

Retrieved from "http://agiwiki.sierrahelp.com//index.php?title=Agikit&oldid=15828"