Skip to content

Commit

Permalink
renamed BP.AdventureFramework to NetAF
Browse files Browse the repository at this point in the history
  • Loading branch information
ben_singer committed Oct 21, 2024
1 parent 0584b5a commit 878cc17
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Ktaf

A Kotlin library that provides a framework for creating text adventures and interactive stories for JVM. Ktaf is a Kotlin implementation of the BP.AdventureFramework.
A Kotlin library that provides a framework for creating text adventures and interactive stories for JVM. Ktaf is a Kotlin implementation of NetAF.
Ktaf aims to provide all of the basic building blocks required to start writing simple games.

[![main-ci](https://github.com/benpollarduk/ktaf/actions/workflows/main-ci.yml/badge.svg?branch=main)](https://github.com/benpollarduk/ktaf/actions/workflows/main-ci.yml)
Expand Down
2 changes: 1 addition & 1 deletion docs/mkdocs/docs/frame-builders.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Overview
In BP.AdventureFramework output is handled using the **FrameBuilders**. A FrameBuilder is essentially a class that builds a **Frame** that can render a specific state in the game. This **Frame** can then be rendered on a **TextWriter** by calling its **Render** method. Think of the **FrameBuilder** as the instructions that build the output display and the **Frame** as the output itself.
In Ktaf output is handled using the **FrameBuilders**. A FrameBuilder is essentially a class that builds a **Frame** that can render a specific state in the game. This **Frame** can then be rendered on a **TextWriter** by calling its **Render** method. Think of the **FrameBuilder** as the instructions that build the output display and the **Frame** as the output itself.

There are a few types of **FrameBuilder**, each responsible for rendering a specific game state.

Expand Down
2 changes: 1 addition & 1 deletion docs/mkdocs/docs/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Welcome
Ktaf is a library that provides a framework for building text adventures and interactive stories in Kotlin or Java.

The repo is open source and is available at [https://github.com/benpollarduk/ktaf](https://github.com/benpollarduk/ktaf). Ktaf has a sister .Net implementation, BP.AdventureFramework, which is available at [https://github.com/benpollarduk/bp.adventureframework](https://github.com/benpollarduk/bp.adventureframework).
The repo is open source and is available at [https://github.com/benpollarduk/ktaf](https://github.com/benpollarduk/ktaf). Ktaf has a sister .Net implementation, NetAF, which is available at [https://github.com/benpollarduk/netaf](https://github.com/benpollarduk/netaf).

This documentation site is a work in progress, if there are any topics that aren't covered that you would like to see included, or if you spot any mistakes please report them on the [Issues](https://github.com/benpollarduk/ktaf/issues) page on GitHub.

0 comments on commit 878cc17

Please sign in to comment.