An standalone binary automation tool for building and validating ALAN IF text-adventures projects, both locally and on GitHub via Travis CI.
Created by Tristano Ajmone on July 12, 2019. MIT License.
Table of Contents
The Alan Builder tool will scan your project for all Alan adventures, compile them and run them against their associated commands scripts to generate game transcripts files, and provide a detailed report (viewable on GitHub commits) of all the operations carried out and the problems encountered, including letter-casing inconsistency in files extensions.
This tool was designed with big Alan projects in mind, for validating a large collection of source adventures and commands scripts scattered across multiple folders — e.g. library projects with a test suite, or large examples collections. But it can be used with projects of any size, including single-adventure projects.
The benefits of adding the Alan Builder to an Alan IF project are manifold:
- It's designed to work with Travis CI, allowing to validate GitHub commits and pull requests via continuous integration.
- It offers end users an easy way to build and update the project locally.
- It allows collaborators to test their contributed material locally, before submitting it to the project (via Git or otherwise).
- It enforces on any Alan project good standards, consistent naming conventions and best practices.
- It ensures that all adventures are compilable and runnable with a specific version of the Alan SDK.
The Alan Builder was created by Tristano Ajmone and donated to the Alan Interactive Fiction Development team under the MIT License.
This means that both its author and the Alan IF Team own the rights of this software, both parties being independently eligible to use it as they wish, including releasing it under different license terms, granting special use permissions to third parties, as well as being both eligible for compensation claims in case of misuses and license violations of this software.
Tristano, as an individual, represents himself for all matters regarding his license ownership.
The Alan Interactive Fiction Development team, as an organization, is represented by Thomas Nilefalk, main developer of Alan and founder of the Alan Interactive Fiction Development team, who represents and acts on behalf of the Team.
MIT License
Copyright (c) 2019 Tristano Ajmone and the Alan IF Development team
https://github.com/alan-if/Alan-Builder
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.