mirror of
https://github.com/ganelson/inform.git
synced 2024-07-05 16:44:21 +03:00
307 lines
15 KiB
Plaintext
307 lines
15 KiB
Plaintext
@-> ../README.md
|
|
# Inform 7 @version(inform7)
|
|
|
|
## About Inform 7
|
|
|
|
Inform 7 (April 2006-) 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 twice ranked in the top 100 most influential programming languages
|
|
according to the TIOBE index.
|
|
|
|
## Licence
|
|
|
|
Except as noted, copyright in material in this repository (the "Package") is
|
|
held by Graham Nelson (the "Author"), who retains copyright so that there is
|
|
a single point of reference. As from the first date of this repository
|
|
becoming public, the Package is placed under the [Artistic License 2.0](https://opensource.org/licenses/Artistic-2.0).
|
|
This is a highly permissive licence, used by Perl among other notable projects,
|
|
recognised by the Open Source Initiative as open and by the Free Software
|
|
Foundation as free in both senses.
|
|
|
|
For the avoidance of doubt, the Author makes the further grant that users of
|
|
the Package may make unlimited use of story files produced by the Package:
|
|
such story files are not derivative works of Inform and do not inherit the
|
|
Artistic License 2.0 as an obligation. (This further grant follows the
|
|
practice of projects like bison, which also copy substantial code into
|
|
their outputs.)
|
|
|
|
## Repositories
|
|
|
|
This is the "core repository", holding source code for the compiler, and
|
|
for everything needed to run it on the command line. However:
|
|
|
|
* To build and test the compiler you also need Inweb and Intest, programs
|
|
spun out from the Inform project. These are __not included in the core
|
|
repository either as submodules or copies__, and have their own repositories.
|
|
If you are new to Inform core development, begin by cloning and building Inweb
|
|
as a stand-alone tool, then use that to build Intest, then return here.
|
|
* [https://github.com/ganelson/inweb](https://github.com/ganelson/inweb), maintained by [Graham Nelson](https://github.com/ganelson)
|
|
* [https://github.com/ganelson/intest](https://github.com/ganelson/intest), maintained by [Graham Nelson](https://github.com/ganelson)
|
|
* Most Inform authors use Inform as an app: for example, it is available
|
|
on the Mac App Store. While much of the UI design is the same across all
|
|
platforms, each app has its own code in its own repository. See:
|
|
* [https://github.com/TobyLobster/Inform](https://github.com/TobyLobster/Inform) for MacOS, maintained by [Toby Nelson](https://github.com/TobyLobster)
|
|
* [https://github.com/DavidKinder/Windows-Inform7](https://github.com/DavidKinder/Windows-Inform7) for Windows, maintained by [David Kinder](https://github.com/DavidKinder)
|
|
* [https://github.com/ptomato/gnome-inform7](https://github.com/ptomato/gnome-inform7) for Linux, maintained by [Philip Chimento](https://github.com/ptomato)
|
|
|
|
## Build Instructions
|
|
|
|
Make a directory in which to work: let's call this "work". Then:
|
|
|
|
* Clone and build Inweb into "work/inweb".
|
|
* Clone and build Intest into "work/intest".
|
|
* Clone Inform into "work/inform". Change the current directory to that.
|
|
Then run "bash scripts/first.sh" (or whatever shell you prefer: it need
|
|
not be bash). This should give you a complete working set of command-line
|
|
Inform tools and associated makefiles. For any future builds, you can simply
|
|
type "make".
|
|
* For a simple test, try e.g. "inblorb/Tangled/inblorb -help". All the
|
|
executables should similarly respond to -help.
|
|
* But for a true test, run "make check". This compiles two more tools needed
|
|
only for testing (dumb-frotz and dumb-glulx), then runs Intest on each tool
|
|
in turn. Some haven't got a test suite, some have; it will run whatever it
|
|
finds. Be advised that on a 2013 laptop this all takes quarter of an hour and
|
|
sounds like a helicopter taking off.
|
|
|
|
## Inventory
|
|
|
|
"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: while the Inform 7 compiler builds to a single
|
|
executable file, this is only useful in concert with other tools (notably the
|
|
Inform 6 compiler and the Inblorb packager), with standard libraries of code
|
|
(called Extensions), with documentation, test cases and so on. This repository
|
|
assembles all those programs and resources, which fall into two categories:
|
|
|
|
### Resources for which this is the primary repository
|
|
|
|
This repository is where development is done on the following:
|
|
|
|
@define primary(program, language)
|
|
* @program - @purpose(@program) - __@version(@program)__ - @language
|
|
@end
|
|
@define book(title, path, topic)
|
|
* @title - @topic. Ebook in Indoc format, stored at path @path.
|
|
@end
|
|
@define extension(path)
|
|
* @path - __@version(@path)__
|
|
@end
|
|
@primary(inform7, 'Web of InC')
|
|
* The I6 Template - The .i6t files used in code generation. Inform 6; held in inform7/Internal/I6T
|
|
* inform7/Internal/Extensions - Libraries of code. Inform 7
|
|
@extension('inform7/Internal/Extensions/Emily Short/Basic Help Menu.i7x')
|
|
@extension('inform7/Internal/Extensions/Emily Short/Basic Screen Effects.i7x')
|
|
@extension('inform7/Internal/Extensions/Emily Short/Complex Listing.i7x')
|
|
@extension('inform7/Internal/Extensions/Emily Short/Glulx Entry Points.i7x')
|
|
@extension('inform7/Internal/Extensions/Emily Short/Glulx Image Centering.i7x')
|
|
@extension('inform7/Internal/Extensions/Emily Short/Glulx Text Effects.i7x')
|
|
@extension('inform7/Internal/Extensions/Emily Short/Inanimate Listeners.i7x')
|
|
@extension('inform7/Internal/Extensions/Emily Short/Locksmith.i7x')
|
|
@extension('inform7/Internal/Extensions/Emily Short/Menus.i7x')
|
|
@extension('inform7/Internal/Extensions/Emily Short/Punctuation Removal.i7x')
|
|
@extension('inform7/Internal/Extensions/Emily Short/Skeleton Keys.i7x')
|
|
@extension('inform7/Internal/Extensions/Eric Eve/Epistemology.i7x')
|
|
@extension('inform7/Internal/Extensions/Graham Nelson/Approximate Metric Units.i7x')
|
|
@extension('inform7/Internal/Extensions/Graham Nelson/English Language.i7x')
|
|
@extension('inform7/Internal/Extensions/Graham Nelson/Metric Units.i7x')
|
|
@extension('inform7/Internal/Extensions/Graham Nelson/Rideable Vehicles.i7x')
|
|
@extension('inform7/Internal/Extensions/Graham Nelson/Unicode Character Names.i7x')
|
|
@extension('inform7/Internal/Extensions/Graham Nelson/Unicode Full Character Names.i7x')
|
|
* inform7/Internal/HTML - Files needed for generating extension documentation and the like. HTML, Javascript, CSS
|
|
* inform7/Internal/Languages - Natural language definition bundles
|
|
* inform7/Internal/Templates - template websites for Inform 7's 'release as a website' feature
|
|
* Internal/Templates/Classic
|
|
* Internal/Templates/Standard
|
|
@primary(inblorb, 'Web of InC')
|
|
@primary(indoc, 'Web of InC')
|
|
@primary(inpolicy, 'Web of InC')
|
|
@primary(inrtps, 'Web of InC')
|
|
@primary(inter, 'Web of InC')
|
|
@primary(srules, 'Web of Inform 7')
|
|
|
|
The "resources" directory holds a number of non-executable items of use to the
|
|
Inform UI applications, and to Inform websites:
|
|
|
|
@book('Changes to Inform', 'resources/Changes', 'A detailed change history of Inform 7')
|
|
@book('Writing with Inform and the Inform Recipe Book', 'resources/Documentation', 'The main Inform documentation, as seen in the apps, and in standalone Epubs')
|
|
* resources/Outcome Pages - Inrtps 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. Inform 7
|
|
|
|
Finally, the "retrospective" directory holds ANSI C source and resources needed
|
|
to build (some) previous versions of Inform 7. At present, this is only sketchily
|
|
put together.
|
|
|
|
Notes:
|
|
|
|
1. The "webs" above are literate programs. This means they can either be
|
|
"tangled" to executables, or "woven" to human-readable forms. The woven
|
|
forms can [all be browsed here](docs/webs.html). They aim to be much easier
|
|
to understand than raw source code found by spelunking through the repository.
|
|
2. "InC" is a slight extension of ANSI C99. These extensions are handled by
|
|
Inweb, which acts as a preprocessor. For more on InC, see the Inweb manual.
|
|
|
|
### 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.)
|
|
|
|
@define secondary(program, for, maintainer, username, repository)
|
|
* @program - @for - __@version(@program)__ - from [https://github.com/@username/@repository], maintained by [@maintainer](https://github.com/@username)
|
|
@end
|
|
@secondary(inform6, 'The Inform 6 compiler (used by I7 as a code generator).', 'David Kinder', DavidKinder, Inform6)
|
|
|
|
@define template(program, for, maintainer, username, repository)
|
|
* @program - @for - __@version(@program)__ - from [https://github.com/@username/@repository], maintained by [@maintainer](https://github.com/@username)
|
|
@end
|
|
* inform7/Internal/Templates - template websites for Inform 7's 'release as a website' feature
|
|
@template('inform7/Internal/Templates/Parchment', 'Z-machine in Javascript', 'Dannii Willis', curiousdannii, parchment)
|
|
@template('inform7/Internal/Templates/Quixe', 'Glulx in Javascript', 'Andrew Plotkin', erkyrath, quixe)
|
|
@template('inform7/Internal/Templates/Vorple', 'Multimedia in Javascript', 'Juhana Leinonen', vorple, inform7)
|
|
|
|
### 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 (**not yet added**)
|
|
* scripts/gitignorescript.txt - Inweb uses this to generate the .gitignore file at the root of the repository
|
|
* scripts/makescript.txt - Inweb uses this to generate a makefile at the root of the repository
|
|
* scripts/READMEscript.txt - Inpolicy uses this to generate the README.md file for the repository
|
|
|
|
### Colophon
|
|
|
|
This README.mk file was generated automatically by Inpolicy, and should not
|
|
be edited. To make changes, edit scripts/READMEscript.txt and re-generate.
|
|
|
|
@-> ../docs/webs.html
|
|
@define web(program, manual)
|
|
<li>
|
|
<p><a href="@program/index.html"><spon class="sectiontitle">@program</span></a> -
|
|
@version(@program)
|
|
- <span class="purpose">@purpose(@program)</span>
|
|
Documentation is <a href="@program/@manual.html">here</a>.</p>
|
|
</li>
|
|
@end
|
|
@define xweb(program)
|
|
<li>
|
|
<p><a href="@program/index.html"><spon class="sectiontitle">@program</span></a> -
|
|
@version(@program)
|
|
- <span class="purpose">@purpose(@program)</span>.</p>
|
|
</li>
|
|
@end
|
|
@define subweb(owner, program)
|
|
<li>
|
|
<p> ↳ <a href="docs/webs.html"><spon class="sectiontitle">@program</span></a> -
|
|
<span class="purpose">@purpose(@owner/@program)</span></p>
|
|
</li>
|
|
@end
|
|
@define mod(owner, module)
|
|
<li>
|
|
<p>↳ <a href="docs/@module-module/index.html"><spon class="sectiontitle">@module</span></a> (module) -
|
|
<span class="purpose">@purpose(@owner/@module-module)</span></p>
|
|
</li>
|
|
@end
|
|
@define extweb(program)
|
|
<li>
|
|
<p><a href="../@program/docs/webs.html"><spon class="sectiontitle">@program</span></a> -
|
|
@version(@program)
|
|
- <span class="purpose">@purpose(@program)</span>
|
|
This has its own repository, with its own ★ Webs page.</p>
|
|
</li>
|
|
@end
|
|
@define extsubweb(owner, program)
|
|
<li>
|
|
<p> ↳ <a href="../@owner/docs/webs.html"><spon class="sectiontitle">@program</span></a> -
|
|
<span class="purpose">@purpose(@owner/@program)</span></p>
|
|
</li>
|
|
@end
|
|
@define extmod(owner, module)
|
|
<li>
|
|
<p>↳ <a href="../@owner/docs/@module-module/index.html"><spon class="sectiontitle">@module</span></a> (module) -
|
|
<span class="purpose">@purpose(@owner/@module-module)</span></p>
|
|
</li>
|
|
@end
|
|
<html>
|
|
<head>
|
|
<title>Inform ★ Webs</title>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<meta http-equiv="Content-Language" content="en-gb">
|
|
<link href="inblorb/inweb.css" rel="stylesheet" rev="stylesheet" type="text/css">
|
|
</head>
|
|
|
|
<body>
|
|
<ul class="crumbs"><li><b>★</b></li><li><b>Webs</b></li></ul>
|
|
<p class="purpose">Human-readable source code.</p>
|
|
<hr>
|
|
<p class="chapter">
|
|
This GitHub project was written as a literate program, powered by a LP tool
|
|
called Inweb. While almost all programs at Github are open to inspection, most
|
|
are difficult for new readers to navigate, and are not structured for extended
|
|
reading. By contrast, a "web" (the term goes back to Knuth: see
|
|
<a href="https://en.wikipedia.org/wiki/Literate_programming">Wikipedia</a>)
|
|
is designed to be read by humans in its "woven" form, and to be compiled or
|
|
run by computers in its "tangled" form.
|
|
These pages showcase the woven form, and are for human eyes only.</p>
|
|
<hr>
|
|
<p class="chapter">Command-line programs needed to use Inform 7:</p>
|
|
<ul class="sectionlist">
|
|
@web('inform7', 'P-p')
|
|
@mod('inform7', 'words')
|
|
@subweb('inform7', 'words-test')
|
|
@mod('inform7', 'inflections')
|
|
@subweb('inform7', 'inflections-test')
|
|
@mod('inform7', 'syntax')
|
|
@subweb('inform7', 'syntax-test')
|
|
@mod('inform7', 'problems')
|
|
@subweb('inform7', 'problems-test')
|
|
@mod('inform7', 'linguistics')
|
|
@subweb('inform7', 'linguistics-test')
|
|
@mod('inform7', 'kinds')
|
|
@subweb('inform7', 'kinds-test')
|
|
@mod('inform7', 'core')
|
|
@subweb('inform7', 'core-test')
|
|
@mod('inform7', 'if')
|
|
@mod('inform7', 'multimedia')
|
|
@mod('inform7', 'index')
|
|
@web('inter', 'P-ui')
|
|
@mod('inter', 'inter')
|
|
@mod('inter', 'codegen')
|
|
@web('inform6', 'P-p')
|
|
@web('inblorb', 'P-ui')
|
|
@extweb('intest')
|
|
</ul>
|
|
<hr>
|
|
<p class="chapter">Resources needed by Inform 7:</p>
|
|
<ul class="sectionlist">
|
|
@xweb('srules')
|
|
</ul>
|
|
<hr>
|
|
<p class="chapter">Command-line programs needed only to build Inform 7:</p>
|
|
<ul class="sectionlist">
|
|
@web('indoc', 'P-iti')
|
|
@web('inpolicy', 'P-ui')
|
|
@web('inrtps', 'P-ui')
|
|
@extweb('inweb')
|
|
@extmod('inweb', 'foundation')
|
|
@extsubweb('inweb', 'foundation-test')
|
|
</ul>
|
|
<hr>
|
|
</body>
|
|
</html>
|