Git Product home page Git Product logo

alan-builder's Introduction

Alan Builder

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


Introduction

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.

License

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.

alan-builder's People

Contributors

tajmone avatar

Watchers

 avatar  avatar

alan-builder's Issues

Adopt New Official Extensions for ALAN3 Solution and Transcript Files

Switch to the upcoming official extensions .a3s and .a3t for ALAN3 solution files and transcripts, respectively (see alan-if/alan#2).

Can't even remember if the .a3sol and .a3log extensions are hardcoded into the tool, and whether it allows using custom extensions (it's been too long since I've worked on it).

Also need to check how this might affect projects which are using the ABuilder app, and ensure that they are updated in sync.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.