Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Transform to modern sphinx framework #9

Draft
wants to merge 20 commits into
base: master
Choose a base branch
from
Draft
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Adapt game dev guide
3ter committed Feb 23, 2024
commit 819e53bb167cbdc54de64c21bbdcb6af1a163f48
14 changes: 13 additions & 1 deletion docs/integrating/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

# Game developer guide

This chapter describes how to distribute software that can be installed
@@ -11,3 +10,16 @@ for creators willing to go the extra mile when integrating with it.
*Note: even though the word 'game' is used throughout this guide, it applies
equally to other kinds of software. Games just happen to be the most popular
kind of software installed with the app!*


```{toctree}
quickstart
manifest/validating-your-manifest
updates
manifest
manifest-actions
prereqs/README
api/README
compatibility-policy
troubleshooting-guide
```
1 change: 0 additions & 1 deletion docs/integrating/platforms/linux.md
Original file line number Diff line number Diff line change
@@ -205,4 +205,3 @@ _Special thanks to Ethan Lee for proofreading this page and contributing advice.
See the Acknowledgements section of this book for a full list of contributors._

[^1]: If they can't, get a better publisher.

3 changes: 1 addition & 2 deletions docs/integrating/platforms/macos.md
Original file line number Diff line number Diff line change
@@ -10,7 +10,7 @@ If you need an [app manifest](/integrating/manifest.md), put your .app and the m

> If you really _really_ want to do something else, read the [Compatibility policy](/integrating/compatibility-policy.md) page.
### ...but I don't have an app bundle
## ...but I don't have an app bundle

App bundles are directories with a standardized structure and some metadata in an `Info.plist` file.

@@ -38,4 +38,3 @@ We've taken several measures to ensure this works properly:
For players that are **not **using the itch.io app, you might get reports of your app being "Damaged and can't be opened" and that it should "be moved to the trash".

Player who do use the itch.io app do not encounter these issues, so you may want to encourage them to use it.

9 changes: 4 additions & 5 deletions docs/integrating/platforms/web.md
Original file line number Diff line number Diff line change
@@ -14,19 +14,18 @@ Like the website, it will look for an `index.html` file \(or a top-level `.html`

You can use `Shift+F12` to open the developer toosl, see [Troubleshooting](/integrating/troubleshooting-guide.md) for more details.

### Fullscreen support
## Fullscreen support

HTML5 games launched with the app can be switched to fullscreen and their window can be resized, so make sure your CSS handles that properly.

### Java applets
## Java applets

Java applets are not supported by the itch.io app.

### Flash games
## Flash games

Flash games are not supported by the itch.io app.

### Legacy Unity plug-in games
## Legacy Unity plug-in games

Legacy Unity plug-in games are not supported by the itch.io app. Use the **WebGL export** option instead.

1 change: 0 additions & 1 deletion docs/integrating/platforms/windows.md
Original file line number Diff line number Diff line change
@@ -29,4 +29,3 @@ However, you'll also have to figure out exactly what libraries you need to ship.
Tools like [Dependency Walker](http://www.dependencywalker.com/) or [Process Monitor](https://docs.microsoft.com/en-us/sysinternals/downloads/procmon) can help.[^1]

[^1]: In fact, anything from [Sysinternals](https://docs.microsoft.com/en-us/sysinternals/downloads/process-utilities) is heartily recommended. If you're not using them, you should be. Nevermind what for - download first, justify second.

9 changes: 9 additions & 0 deletions docs/integrating/prereqs/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
# Prerequisites

```{toctree}
:hidden:
prereqs/vc
prereqs/dotnet
prereqs/xna
prereqs/dx
```

Since we encourage developers to ship [portable builds](../platforms/windows.md), the app supports installing frameworks or libraries your game might depend on.

Here's how it looks for users:
9 changes: 9 additions & 0 deletions docs/integrating/quickstart.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
# Game developer quick start

```{toctree}
:hidden:
platforms/windows
platforms/macos
platforms/linux
platforms/web
```

Chances are, your software already works with [the itch.io app](https://itch.io/app).

But **keep reading!** This page also contains best practices.