(Mirror with no changes) The core software distribution for the Inform 7 programming language.
Go to file
Graham Nelson 0726b2cbf1 Moved implications from Extensions chapter to Kinds chapter 2024-04-09 18:44:05 +01:00
docs Updated docs 2024-04-08 22:39:30 +01:00
docs-src Converted documentation and examples to Markdown and removed indoc from build process 2024-04-03 22:06:16 +01:00
inblorb Fix for Jira bug I7-2293 2024-04-08 22:38:02 +01:00
inbuild Miscellaneous HTML generation infelicities fixed 2024-04-04 23:25:29 +01:00
indoc Dublin Core, not Durham Core 2024-01-18 18:12:06 +00:00
inform6 Adapted parser to the new truncated dictionary word bit provided by I6 2024-03-12 08:54:17 +00:00
inform7 Moved implications from Extensions chapter to Kinds chapter 2024-04-09 18:44:05 +01:00
inpolicy Converted documentation and examples to Markdown and removed indoc from build process 2024-04-03 22:06:16 +01:00
inter Fix for Jira bug I7-2293 2024-04-08 22:38:02 +01:00
notes Corrected ideal transcripts in light of PR#138 2024-04-05 11:29:59 +01:00
resources Moved implications from Extensions chapter to Kinds chapter 2024-04-09 18:44:05 +01:00
retrospective Corrected release date for 10.1 2022-08-29 22:22:28 +01:00
scripts Documented number bases portion of IE-0026 2024-04-08 00:12:29 +01:00
services Updated docs 2024-04-08 22:39:30 +01:00
.editorconfig Fix kit enumerated kinds to allow for consecutive values 2023-07-05 14:10:50 +10:00
.gitignore Add *.exe to .gitignore 2023-07-08 14:33:20 +01:00
LICENSE Create LICENSE file 2022-05-06 17:33:18 +10:00
README.md Fix for Jira bug I7-2293 2024-04-08 22:38:02 +01:00
build.txt Fix for Jira bug I7-2293 2024-04-08 22:38:02 +01:00
colony.txt Migrated outcome pages to Markdown and removed inrtps tool 2023-08-26 15:14:13 +01:00

README.md

Inform 7

Version: 10.2.0-beta+6X42 'Krypton' (8 April 2024)

About Inform

Inform is a programming language for creating interactive fiction, using natural language syntax. Using natural language and drawing on ideas from linguistics and from literate programming, Inform is widely used as a medium for literary writing, as a prototyping tool in the games industry, and in education, both at school and university level (where Inform is often assigned material for courses on digital narrative). It has several times ranked in the top 100 most influential programming languages according to the TIOBE index. Created in April 2006, it was open-sourced in April 2022.

Inform is itself a literate program (written with inweb), one of the largest in the world. This means that a human-readable form of the code is continuously maintained alongside it: see ★ Inform: The Program

Software in this repository is copyright Graham Nelson 2006-2022 except where otherwise stated, and available under the Artistic License 2.0.

To consult... Turn to...
Brief news about ongoing work notes/working_notes.md
Licencing and copyright policy notes/copyright.md
Branching and versioning policy notes/versioning.md
Language evolution policy https://github.com/ganelson/inform-evolution
Version history and release notes notes/version_history.md
Pending changes not yet released notes/release/pending.md

Repositories

This is the "core Inform" repository, holding source code for the compiler, and for everything needed to run it on the command line. However:

Build Instructions

Caution: The main branch of this repository generally holds "unstable", that is, unreleased work-in-progress versions of Inform. See notes/versioning.md.

Make a directory in which to work: let's call this work. Then:

  • Change the current directory to work: cd work
  • Build Inweb as work/inweb: see its repository here
  • Build Intest as work/intest: see its repository here
  • Clone Inform as work/inform: git clone https://github.com/ganelson/inform.git
  • Change the current directory to this: cd inform
  • Run a first-build script: bash scripts/first.sh
  • Check executables have compiled: inblorb/Tangled/inblorb -help
  • Run a single test case: ../intest/Tangled/intest inform7 -show Acidity.
  • If you have time (between 5 mins and 2 hours, depending on your system), make check to run the full suite of 2500 test cases.

Caution again: inform7 is written in standard C99, but is a challengingly large task for a C compiler. In the past we have had difficulties using gcc to compile it, and although we believe these may now be resolved, we recommend compiling the core Inform tools with clang rather than gcc where possible.

Issues and Contributions

The 2006-2021 Inform bug tracker, powered by Mantis, has now closed, and its issues and comments have been migrated to a a Jira tracker. The curator of the bug tracker is Brian Rushton, and the administrator is Hugo Labrande.

Note that Inweb and Intest have their own bug trackers (here and here). Please do not report bugs on those to the Inform tracker, or vice versa.

Members of the Inform community are welcome to open pull requests on this repository to address minor issues - for example, to fix bugs at the tracker, or to correct clear-cut typos or other errors. Contributions of this sort do not need an Inform Evolution proposal, but anything on a larger scale is likely to.

Inventory of this Repository

"I can't help feeling that if someone had asked me before the universe began how it would turn out, I should have guessed something a bit less like an old curiosity shop and a bit more like a formal French garden - an orderly arrangement of straight avenues, circular walks, and geometrically shaped trees and hedges." (Michael Frayn)

Inform is not a single program, but an assemblage of programs and resources. Some, including the inform7 compiler itself, are "literate programs", also called "webs". The notation ★ marks these, and links are provided to their human-readable forms.

Source for command-line tools

This most important contents of this repository are the source webs for the following command-line tools:

Kits shipped with Inform

The following webs are the source for kits of Inter code shipped with Inform (at the subtree inform7/Internal/Inter). Kits are libraries of code needed at run-time, and whose source is written in Inform 6 notation:

  • BasicInformKit - Support for Inform as a programming language - ★ Web
  • Architecture16Kit - Support for running on 16-bit platforms - ★ Web
  • Architecture32Kit - Support for running on 32-bit platforms - ★ Web
  • WorldModelKit - Support for modelling space, time and actions in interactive fiction - ★ Web
  • EnglishLanguageKit - Support for English as the natural language used - ★ Web
  • CommandParserKit - Support for parsing turn-by-turn commands in interactive fiction - ★ Web
  • DialogueKit - Additional support for dialogue (under construction) - ★ Web

Extensions shipped with Inform

The following webs are the source for the two most important extensions shipped with Inform:

Other extensions shipped with Inform are not presented as webs, but as single files:

Website templates and interpreters shipped with Inform

These are templates used by Inform to release story files within a website:

  • Classic - An older, plainer website
  • Standard - The default, more modern look

These are Javascript interpreters used to release such websites in a form which can play the story files interactively online:

Documentation shipped with Inform

Two books come with the Inform apps. The source code for these books is in indoc format: the indoc tool makes those into ePubs, mini-websites, or the pseudo-websites inside the apps.

  • Changes to Inform - A detailed change history of Inform 7. Ebook in Indoc format, stored at path resources/Changes.
  • Writing with Inform and the Inform Recipe Book - The main Inform documentation, as seen in the apps, and in standalone Epubs. Ebook in Indoc format, stored at path resources/Documentation.

In addition, there are:

  • resources/Outcome Pages - Inbuild uses these to generate HTML outcome pages (such as those showing Problem messages in the app)
  • resources/Sample Projects - Two small interactive fictions, 'Disenchantment Bay' and 'Onyx', presented as samples in the app

Retrospective builds of Inform

New in 2022 is the ability for apps to use past instead of present versions of the core Inform software when compiling a project. This means the core software distribution needs to contain some form of those past versions - at minimum, the extensions and compiler tools for (say) versions 9.1, 9.2 and 9.3.

That material is held in the "retrospective" directory. Note that documentation from past versions (e.g., past versions of "Writing with Inform") is not included.

Resources copied here from elsewhere

Stable versions of the following are periodically copied into this repository, but this is not where development on them is done, and no pull requests will be accepted. (Note that these are not git submodules.)

Binary resources (such as image files)

  • resources/Imagery/app_images - icons for the Inform app and its many associated files, in MacOS format
  • resources/Imagery/bg_images - background textures used in the Index generated by Inform
  • resources/Imagery/doc_images - miscellaneous images needed by the documentation
  • resources/Imagery/map_icons - images needed for the World pane of the Index generated by Inform
  • resources/Imagery/outcome_images - images used on outcome pages
  • resources/Imagery/scene_icons - images needed for the Scenes pane of the Index generated by Inform
  • resources/Internal/Miscellany - default cover art, the Introduction to IF and Postcard PDFs

Other files and folders in this repository

  • docs - Woven forms of the webs, for serving by GitHub Pages
  • scripts/inform.giscript - Inweb uses this to generate the .gitignore file at the root of the repository
  • scripts/inform.mkscript - Inweb uses this to generate the makefile at the root of the repository
  • scripts/inform.rmscript - Inweb uses this to generate the README.md file you are now reading

Colophon

This README.md file was generated automatically by Inweb, and should not be edited. To make changes, edit inform.rmscript and re-generate.