https://github.com/jeffnyman/inform6-playground
Simplified Distribution of the Inform 6 Interactive Fiction System
https://github.com/jeffnyman/inform6-playground
Last synced: 3 months ago
JSON representation
Simplified Distribution of the Inform 6 Interactive Fiction System
- Host: GitHub
- URL: https://github.com/jeffnyman/inform6-playground
- Owner: jeffnyman
- License: other
- Created: 2023-09-16T09:20:21.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-11-20T12:16:43.000Z (over 1 year ago)
- Last Synced: 2025-01-30T05:42:24.971Z (4 months ago)
- Language: C
- Size: 1010 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Inform 6 Playground
_Simplified Distribution of the Inform 6 Interactive Fiction System_
This repository contains a simplified distribution of [Inform 6](https://www.inform-fiction.org/). This includes the standard library as well as the executables for Mac and Windows systems.
The Inform 6 library is currently distributed at [inform6lib](https://gitlab.com/DavidGriffith/inform6lib). This repository includes version 6.12.6 of the library.
The Puny Inform library is currently distributed at [PunyInform](https://github.com/johanberntsson/PunyInform). This repository includes version 5.1 of the library.
The Inform 6 source is currently distributed at [Inform6](https://github.com/DavidKinder/Inform6). This repository includes version 6.41 of Inform.
Beyond being distributed at the above links, all of the Inform 6 ecosystem is available within the ["inform6"](https://ifarchive.org/indexes/if-archive/infocom/compilers/inform6/) area of the if-archive.
## Documentation
Inform 6 has a series of documentation reference points.
- [The Inform Designer's Manual v4](https://www.inform-fiction.org/manual/html/index.html) (HTML)
- [The Inform Designer's Manual v4](https://www.inform-fiction.org/manual/DM4.pdf) (PDF)
- [The Inform Beginner's Guide](https://www.inform-fiction.org/manual/IBG.pdf) (PDF)
- [PunyInform documentation](https://github.com/johanberntsson/PunyInform/tree/master/documentation)
## Usage
If you clone this repository, it's set up to ignore a `project` or `projects` directory. You can set the location of the provided Inform 6 executable on your system path. A simple Inform 6 example would be this:
```inform6
[ Main;
print "Testing Inform 6^";
];
```
If that code is stored in a file called `learn.inf`, then you could then compile that with:
`inform6 learn.inf`
Let's say that you have a program that uses the Inform 6 library. Consider this:
```inform6
Constant Story "RUINS";
Constant Headline "^An Interactive Example^";
Include "Parser";
Include "VerbLib";
[ Initialise;
"^^^A discovery looms before you ...";
];
Include "Grammar";
```
If that code is stored in a file called `ruins.inf`, then you could compile that with:
`inform6 ruins.inf +include_path=../lib/`
With Inform 6, you can also provide what are called "ICL commands" within the source code of your program. If you didn't want to specify the include path at the command line, as above, you could include this line in your source at the top of the file:
```inform6
!% +include_path=../lib
```
Keep in mind that if you place your project in a subdirectory within your projects directory, you will have to adjust the relative paths accordingly. The idea, however, is that everything is done relative to the Inform 6 playground structure.
### Using PunyInform
To use PunyInform, you can just point to the `lib-puny` library. So your source code would look like this:
```inform6
!% +include_path=../lib-puny
!% -v3
Constant Story "Minimal";
Constant Headline "^A sample game using PunyInform.^";
Constant INITIAL_LOCATION_VALUE = library;
Include "globals.h";
Include "puny.h";
Object library "The Library"
with
description "You are in a library."
;
[ Initialise;
print "^^The story begins ...^^";
];
```