From 780ac6e529ed04ae0b73ebd39c83282342d48ede Mon Sep 17 00:00:00 2001 From: Andrew Thurman Date: Feb 13 2021 19:12:16 +0000 Subject: General housekeeping We need to be careful when documenting emulators! --- diff --git a/antora.yml b/antora.yml index 2d25ecc..82ee622 100644 --- a/antora.yml +++ b/antora.yml @@ -3,7 +3,7 @@ name: gaming # <---- PLEASE MODIFY # Title will be visible on the page. -title: Fedora gaming # <---- PLEASE MODIFY +title: Fedora Gaming # <---- PLEASE MODIFY # If you don't plan to have multiple versions of the docs (for example, to document multiple versions of some software), you can ignore this field. Otherwise, change "master" to a specific version. version: master diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index fac81ae..0f2810c 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -1,13 +1,13 @@ * xref:index.adoc[Welcome] * xref:mission.adoc[Mission] -* xref:communicating.adoc[Getting in touch] -* xref:contributing.adoc[Join us] +* xref:communicating.adoc[Getting in Touch] +* xref:contributing.adoc[Join Us] * xref:game-installation.adoc[Installations] -** xref:proton.adoc[Proton with Steam] -** xref:gameboy-emulator.adoc[Gameboy emulator] -* xref:game-development.adoc[Game development] -* xref:community.adoc[Gaming community] -* xref:game-links.adoc[Gaming links] -** xref:game-sites.adoc[Gaming news sites] -** xref:game-lists.adoc[Game list references] +** xref:proton.adoc[Proton With Steam] +** xref:gameboy-emulator.adoc[Gameboy Emulator] +* xref:game-development.adoc[Game Development] +* xref:community.adoc[Gaming Community] +* xref:game-links.adoc[Gaming Links] +** xref:game-sites.adoc[Gaming News Sites] +** xref:game-lists.adoc[Game List References] * xref:faq.adoc[FAQ] diff --git a/modules/ROOT/pages/communicating.adoc b/modules/ROOT/pages/communicating.adoc index 889e1ab..cf5e7d3 100644 --- a/modules/ROOT/pages/communicating.adoc +++ b/modules/ROOT/pages/communicating.adoc @@ -1,24 +1,16 @@ -= Communicating and getting help - - - -For general troubleshooting help related to Fedora, please refer to link:https://ask.fedoraproject.org[ask Fedora forum]. - -If you found a bug, report it += Communicating and Getting Help + +For general troubleshooting help related to Fedora, please refer to link:https://ask.fedoraproject.org[Ask Fedora Forum]. + +If you found a bug, report it! * link:https://docs.fedoraproject.org/en-US/quick-docs/howto-file-a-bug/[How to file a bug]. -For anything related to gaming, please use the following channels: +If you have specific questions/ideas about gaming or game development, or want to introduce yourself +and join the team, come visit us at the link:https://discussion.fedoraproject.org/c/desktop/gaming[Gaming Discussion Form]! -* Join us at link:https://discussion.fedoraproject.org/c/desktop/gaming[gaming discussion forum]. - - * Issues about gaming documentation can be filed at link:https://pagure.io/gaming/documentation/issues[ticketing repository on Pagure]. - - -* You can chat with us at link:https://webchat.freenode.net/?channels=#fedora-games[#fedora-games on irc.freenode.net], or our link:https://matrix.to/#/!duZFcjensgiBWcrjwO:matrix.org?via=matrix.org&via=t2bot.io[Element/Matrix channel]. Chats are bridged so you can use either one of them. - -* You can e-mail us on the Games mailing list at link:https://lists.fedoraproject.org/admin/lists/games@lists.fedoraproject.org/[games@lists.fedoraproject.org]. - +* You can chat with us at link:https://webchat.freenode.net/?channels=#fedora-games[#fedora-games on irc.freenode.net], or our link:https://matrix.to/#/!duZFcjensgiBWcrjwO:matrix.org?via=matrix.org&via=t2bot.io[Element/Matrix channel]. Chats are bridged, so you can use either one of them. +* You can e-mail us on the Games mailing list at link:https://lists.fedoraproject.org/admin/lists/games@lists.fedoraproject.org/[games@lists.fedoraproject.org]. diff --git a/modules/ROOT/pages/community.adoc b/modules/ROOT/pages/community.adoc index e64aee9..949dc50 100644 --- a/modules/ROOT/pages/community.adoc +++ b/modules/ROOT/pages/community.adoc @@ -1,5 +1,6 @@ = Gaming Community -Our community is being revitalized. +We are revitalizing our community. + +We welcome all new ideas and help. You can use the link at the bottom of this page or get in touch through various ways specified in the getting in touch page on the left. -We welcome all new ideas and help. You can use the link at the bottom of this page or get in touch through various ways specified in Getting in touch page on the left. diff --git a/modules/ROOT/pages/contributing.adoc b/modules/ROOT/pages/contributing.adoc index 31e7fa4..19a8304 100644 --- a/modules/ROOT/pages/contributing.adoc +++ b/modules/ROOT/pages/contributing.adoc @@ -1,20 +1,16 @@ -= Contributing - -:toc: macro - -:toc-title: Contents - += Frequently Asked Questions (FAQ) - -NOTE: A link:https://admin.fedoraproject.org/accounts/[Fedora account] is required to access the link:https://apps.fedoraproject.org/[applications] and link:https://fedoraproject.org/wiki/Infrastructure[infrastructure] used by the Fedora community. It only takes a minute to set up! You can learn more about the Fedora project link:https://docs.fedoraproject.org/en-US/project/[here]. - +[qanda] +Can I see a built preview of this template to get a better idea about the result?:: + Of course you can! Just look at the README of the repository — it should tell you everything. +Is writing documentation hard and dreadful?:: + Absolutely not. Writing documentation in asciidoc is simple and straightforward. In fact, writing documentation can be very fun. Just try and see for yourself! - -Games interest group is a community supported initiative, and team members work on it in their free time. - -We are always looking for more hands to help with gaming, and we are more than happy to help people learn the technical skills required to contribute. - -Please xref:communicating.adoc[get in touch] if you would like to join the team! - +How do I install a game not listed here?:: + We are planning to add basic instructions on how to get started. You can contact us for more information. Help can be relieved from the Getting in Touch page on the left. - +I have a great idea:: +I have good instructions you could use:: +I think that...:: + We welcome all new ideas and help. You can use the link at the bottom of this page or see xref:contributing.adoc[our contributing page] + diff --git a/modules/ROOT/pages/faq.adoc b/modules/ROOT/pages/faq.adoc index 2f19e98..07a3862 100644 --- a/modules/ROOT/pages/faq.adoc +++ b/modules/ROOT/pages/faq.adoc @@ -2,15 +2,18 @@ [qanda] Can I see a built preview of this template to get a better idea about the result?:: + Of course you can! Just look at the README of the repository — it should tell you everything. + Is writing documentation hard and dreadful?:: - Absolutely not. Writing documentation in asciidoc is very simple and straightforward. And in fact, writing documentation makes you very happy. Just try and see for yourself! + + Absolutely not. Writing documentation in asciidoc is simple and straightforward. In fact, writing documentation can be very fun. Just try and see for yourself! How do I install a game not listed here?:: - We are planning to add basic instructions on how to get started. You can contact us for more information. Instructions can be found in Getting in touch page on the left. + + We are planning to add basic instructions on how to get started. You can contact us for more information. Help can be received from the Getting in Touch page on the left. I have a great idea:: -I have good instructions you could use:: -I Think that ...:: - We welcome all new ideas and help. You can use the link at the bottom of this page or get in touch through various ways specified in Getting in touch page on the left. + + We welcome all new ideas and help. You can use the link at the bottom of this page or see xref:contributing.adoc[our contributing page]. diff --git a/modules/ROOT/pages/game-development.adoc b/modules/ROOT/pages/game-development.adoc index 648e974..e24c293 100644 --- a/modules/ROOT/pages/game-development.adoc +++ b/modules/ROOT/pages/game-development.adoc @@ -1,4 +1,4 @@ -== Game development +== Game Development Mission for game development: @@ -8,13 +8,13 @@ Provide developers a platform that has a working production pipeline out of the Game development tooling that is available on Linux include -* Gimp +* Gimp * Inkscape * Krita * Synfig * Blender * Godot -=== Possible sample projects === +=== Possible Sample Projects === Blender and Godot are fantastic pieces of software. diff --git a/modules/ROOT/pages/game-installation.adoc b/modules/ROOT/pages/game-installation.adoc index 0a4db1f..f61c18d 100644 --- a/modules/ROOT/pages/game-installation.adoc +++ b/modules/ROOT/pages/game-installation.adoc @@ -1,28 +1,28 @@ -== Game installation +== Game installation -NOTE: Some of these platforms are not supported out of the box due to current policies, thus requiring some additional steps to use, most common need is setting up RPM-Fusion repository as instructed https://docs.fedoraproject.org/en-US/quick-docs/setup_rpmfusion/[here]. +NOTE: Fedora does not support some of these platforms out of the box due to current policies, thus requiring some additional steps to use. The most common need is setting up RPM-Fusion repository as instructed https://docs.fedoraproject.org/en-US/quick-docs/setup_rpmfusion/[here]. -Games can be installed and played several different ways, here are some of them: +Games can be installed and played several ways, here are some of them: === Lutris === -On the surface its just a standard launcher for all kinds of games (steam/native/wine/emulated etc) but its so much more. It supports install scripts and everything so you can install native and non-native games from GOG using the correct wine settings without the user having to do anything. You can log in to your existing GOG account as well and directly hit install inside Lutris. This is already in the Fedora repos. +On the surface it's just a standard launcher for all kinds of games (steam/native/wine/emulated etc) but it's so much more. It supports install scripts and everything, so you can install native and non-native games from GOG using the correct wine settings without the user having to do anything. You can log in to your existing GOG account as well and directly hit install inside Lutris. This is already in the Fedora repos. === Emulators === -Some of them are already packaged into Fedora. Most are available as Flatpaks. Retroarch (combined frontend for a lot of older (pre 2000) emulators) is trending these days. Retroarch is already in the repos. +Some of them are already packaged into Fedora. Most are available as Flatpaks. Retroarch (combined frontend for a lot of older (pre-2000) emulators) is trending these days. Retroarch is already in the repos. === Flatpak === Some proprietary but native Linux games have flatpak builds. Ex Runescape or Minecraft. Flatpak is an excellent platform for native proprietary games. -=== Native open source games === +=== Native Open Source Games === The repos have some decent games like xonotic or red eclipse. === Steam === -Some native Linux Steam games have issues with the lack of 32 bit libraries which can be fixed by using the Flatpak version of Steam instead of the rpm. Steam’s Proton is the single biggest thing that has boosted Linux gaming. When anyone thinks of Linux gaming, they think of Proton. Valve as a company has done a lot to encourage Linux gaming. All of Valve’s self published games are Linux native including Half Life Alyx which is a VR title. +Some native Linux Steam games have issues with the lack of 32 bit libraries which can be fixed by using the Flatpak version of Steam instead of the rpm. Steam’s Proton is the single biggest thing that has boosted Linux gaming. When anyone thinks of Linux gaming, they think of Proton. Valve as a company has done a lot to encourage Linux gaming. All of Valve’s self-published games are Linux native including Half Life Alyx which is a VR title. diff --git a/modules/ROOT/pages/gameboy-emulator.adoc b/modules/ROOT/pages/gameboy-emulator.adoc index 5b99cf6..ef748d1 100644 --- a/modules/ROOT/pages/gameboy-emulator.adoc +++ b/modules/ROOT/pages/gameboy-emulator.adoc @@ -1,37 +1,33 @@ -== Gameboy emulator == +== Game Boy Emulator == -This will enable running of Gameboy games (which often have .gba extension) +This will enable running of Game Boy games (which often have .gba extension) -=== Installation using software installation program === +=== Installation Using Software Installation Program === Generic instructions on installations can be found https://docs.fedoraproject.org/en-US/quick-docs/finding-and-installing-linux-applications/[here]. On Gnome: From _Activities_ menu choose _software_ and search for: -*VisualBoyAdvance-M* +*VisualBoyAdvance-M* Choose *install* -Program can be then be found as *VBA-M* on your desktop (and alternatively under _applications .. games_, if you have applications menu enabled). +You can then find the program as *VBA-M* on your desktop (and alternatively under _Applications .. Games_, if you have applications menu enabled). You can now choose Launch from the software installer. -=== Installation using dnf === +=== Installation Using DNF === ---- sudo dnf install visualboyadvance-m ---- -=== running the emulator === +=== Running the Emulator === -First you need a ROM file, one site providing them is https://emulator.games/ - -From VBA-M choose file .. open .. gba-file +From VBA-M choose file .. Open .. gba-file You can choose (and verify) your game-keys from: -Options .. input .. configure - - - +Options .. Input .. Configure +//We need to be cautious when writing documentation like this. The emulator.games link was unacceptable. See also: https://www.howtogeek.com/262758/is-downloading-retro-video-game-roms-ever-legal/ diff --git a/modules/ROOT/pages/mission.adoc b/modules/ROOT/pages/mission.adoc index 39663e7..8f91e31 100644 --- a/modules/ROOT/pages/mission.adoc +++ b/modules/ROOT/pages/mission.adoc @@ -1,14 +1,10 @@ == Mission -Goal: Help make gaming and game development on Fedora Linux better for everyone! +*_Help make gaming and game development on Fedora Linux better for everyone!_* -The Fedora Project is full of gamers and game developers, and we want to talk about it! Whether you want technical help or just want to discuss gameplay, you can come to the Games SIG and feel at home: - -https://discussion.fedoraproject.org/t/the-games-sig-is-dead-should-it-be-revived/26264/21?u=copperi[Initial Proposal] - -https://discussion.fedoraproject.org/c/desktop/gaming/[Fedora Gaming Discussion] - -== Ideas and wishes for the future of Games SIG +The Fedora Project is full of gamers and game developers, and we want to talk +about it! Whether you want technical help or just want to discuss gameplay, +you can come to the Games SIG and feel at home: Current High-Level Goals: @@ -16,8 +12,14 @@ Current High-Level Goals: * Gathering more interested gamers and contributors. * https://discussion.fedoraproject.org/t/about-the-gaming-category/26110/2?u=copperi[Discussions on support for various graphics cards] * https://discussion.fedoraproject.org/t/learning-fedora-linux-through-gaming/26153[Learning Fedora through gaming] +* https://discussion.fedoraproject.org/t/comps-group-for-games-maintenance-needed/26947?u=nickavem[Find package maintainers and fix the "Games" dnf group] //// image::super_mario.png[Gaming] Let's try and avoid the use of possibly copyrighted characters, even if they are fun; Fedora Gaming Art? //// + +=== Nostalgia + +* https://discussion.fedoraproject.org/t/the-games-sig-is-dead-should-it-be-revived/26264/21?u=copperi[Initial Proposal] + diff --git a/site.yml b/site.yml index 98babbf..76f34fe 100644 --- a/site.yml +++ b/site.yml @@ -1,5 +1,5 @@ site: - title: Local Preview - Fedora gaming + title: Local Preview - Fedora Gaming start_page: gaming::index content: sources: