mirror of
https://github.com/MoHadiShibli/Control4Free.git
synced 2026-10-25 01:01:24 +02:00
Documentation for 1.0.0: README, guides, screenshots, GitHub files
- README: what Control4Free is and why it reaches menus and sign-in, features, a quick start, screenshots, requirements, limitations, credits. - docs/: installation, playing, troubleshooting (every message the page and the app can show), how it works, and the WebSocket protocol. - CONTRIBUTING.md: building, testing, code style, releasing. - Screenshots of the page on phones and a PC and of the app, made against the real service built for the host, at the example address 192.168.1.20. - Issue forms, a contact list pointing at the guides and private security reporting, and FUNDING.yml. - CHANGELOG.md dated. CI now publishes this version's section of it as the release notes rather than the whole file. - THIRD_PARTY.md: the DualShock 4 diagram the buttons are drawn after (CC BY 3.0), and Apollo Save Tool for the package settings. - Page: the Vibration setting no longer promises to buzz when a game rumbles, which 1.0.0 cannot do yet.
This commit is contained in:
1 parent
77a1bba68d
commit
5335bc09ce
20 files changed
+881
-226
No files matched your search
@@ -0,0 +1 @@
|
||||
ko_fi: mohadishibli
|
||||
@@ -0,0 +1,49 @@
|
||||
name: Bug report
|
||||
description: Something doesn't work as it should
|
||||
labels: [bug]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for reporting! First, please check the [troubleshooting guide](https://github.com/MoHadiShibli/Control4Free/blob/main/docs/troubleshooting.md): most setup problems are covered there.
|
||||
- type: input
|
||||
id: version
|
||||
attributes:
|
||||
label: Control4Free version
|
||||
description: Shown at the bottom of the controller page and of the app, for example "Control4Free 1.0.0".
|
||||
validations:
|
||||
required: true
|
||||
- type: input
|
||||
id: console
|
||||
attributes:
|
||||
label: Firmware and GoldHEN version
|
||||
placeholder: "Firmware 10.01, GoldHEN v2.4b18.10"
|
||||
validations:
|
||||
required: true
|
||||
- type: input
|
||||
id: client
|
||||
attributes:
|
||||
label: Phone or computer, and browser
|
||||
placeholder: "Android phone, Chrome"
|
||||
validations:
|
||||
required: true
|
||||
- type: input
|
||||
id: where
|
||||
attributes:
|
||||
label: Where it happened
|
||||
description: The home screen, the sign-in screen, a game (name and title ID, like CUSA00001), or the app.
|
||||
- type: textarea
|
||||
id: what
|
||||
attributes:
|
||||
label: What happened?
|
||||
description: What did you do, what did you expect, and what happened instead?
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: log
|
||||
attributes:
|
||||
label: Log (optional)
|
||||
description: |
|
||||
`/data/control4free/control4free.log` on the PS4, over GoldHEN's FTP server (port 2121). If the problem was before a restart, it's in `control4free.log.previous`.
|
||||
The log contains your console's network address: remove it if you prefer.
|
||||
render: text
|
||||
@@ -0,0 +1,8 @@
|
||||
blank_issues_enabled: true
|
||||
contact_links:
|
||||
- name: Installation and troubleshooting
|
||||
url: https://github.com/MoHadiShibli/Control4Free/blob/main/docs/troubleshooting.md
|
||||
about: Setting up, playing, and fixes for the most common problems.
|
||||
- name: Report a security problem
|
||||
url: https://github.com/MoHadiShibli/Control4Free/security
|
||||
about: Please report vulnerabilities privately, not in a public issue.
|
||||
@@ -0,0 +1,16 @@
|
||||
name: Feature request
|
||||
description: An idea to make Control4Free better
|
||||
labels: [enhancement]
|
||||
body:
|
||||
- type: textarea
|
||||
id: idea
|
||||
attributes:
|
||||
label: What would you like?
|
||||
description: Describe the idea and the problem it solves.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: games
|
||||
attributes:
|
||||
label: Games it matters for (optional)
|
||||
description: Game names and title IDs, if it's about specific games.
|
||||
@@ -56,4 +56,9 @@ jobs:
|
||||
if: startsWith(github.ref, 'refs/tags/v')
|
||||
env:
|
||||
GH_TOKEN: ${{ github.token }}
|
||||
run: gh release create "${GITHUB_REF#refs/tags/}" artifacts/* --verify-tag --notes-file CHANGELOG.md
|
||||
run: |
|
||||
# The release notes are this version's section of the changelog.
|
||||
version=$(cat VERSION)
|
||||
awk -v head="## $version " 'index($0, head) == 1 { keep = 1; next } /^## / { keep = 0 } keep' CHANGELOG.md > notes.md
|
||||
test -s notes.md || { echo "CHANGELOG.md has no section for $version"; exit 1; }
|
||||
gh release create "${GITHUB_REF#refs/tags/}" artifacts/* --verify-tag --title "Control4Free $version" --notes-file notes.md
|
||||
Reference in new issue
Block a user