Adventure Game Studio

AGS Development => Site & Forum Reports => Topic started by: Hobbes on Tue 01/06/2021 12:32:26

Title: AGS Wiki Updates/Discussion
Post by: Hobbes on Tue 01/06/2021 12:32:26
First things first: Sorry for yet another thread about the website.

The reason being is that I've started going through the Wiki. It'll probably be at a glacial pace, however, I think it's worth having one thread to collect all Wiki things. Then if I do something people don't think should happen, we can discuss that here instead of littering the "Broken Links" thread.

I'll add more posts as I update things.

I've taken the contents from the Community page on the AGS website and created a Communities Wiki page instead. This will enable the new site to just have a "Forums" link instead. The wiki Category "AGS Community and history" already existed anyway with quite a few pages, so it'll be easy to build from there and also link some more stuff in. I've added the Reddit link there now as well, since that wasn't on the main website. Snarky wanted a Discord link, but after checking the Community page, it already had a link to it, so I've just copied that across.

Since it's a wiki and anyone can edit, please, add more communities that you're aware of!
Title: Re: AGS Wiki Updates/Discussion
Post by: Hobbes on Tue 01/06/2021 12:51:04
I've created a new Wiki Category called "Archived-Broken". People can fix these and then we can move them back into the Main Wiki. Or we can mark them for deletion and clear up the Wiki.

Instructions: If you add this to the bottom of a Wiki page, it will automatically be moved into this Category (be sure to remove the other categories to avoid confusion):



[[Category:Archived-Broken]]
Title: Re: AGS Wiki Updates/Discussion
Post by: eri0o on Tue 01/06/2021 12:52:39
Unless anyone here is the mod of that reddit community it should be on the unofficial categories.
Title: Re: AGS Wiki Updates/Discussion
Post by: Hobbes on Tue 01/06/2021 13:40:31
Further tidied up the AGS Community / History thing and actually split it into two categories: AGS Community & AGS History. Should help newbies understand what's recent and what isn't. Then if people want to, they can dive into the History part.

I'll work on some more paragraphs and stuff to clarify this as we move forward.
Title: Re: AGS Wiki Updates/Discussion
Post by: eri0o on Tue 01/06/2021 15:47:33
The topic here could be lifted to the wiki: (Encyclopedia of every adventure games puzzles ever) https://www.adventuregamestudio.co.uk/forums/index.php?topic=56612.0

Also the treasure trove may be useful for placeholders when getting started: https://www.adventuregamestudio.co.uk/forums/index.php?topic=55998.0

And this particular forum is useful for more information for people downloading the Editor: https://www.adventuregamestudio.co.uk/forums/index.php?board=28.0

The community pick of the month is decided here: https://www.adventuregamestudio.co.uk/forums/index.php?topic=48959.0
Title: Re: AGS Wiki Updates/Discussion
Post by: AGA on Tue 01/06/2021 20:26:10
The wiki is temporarily offline, while I upgrade some stuff.  Won't be long!
Title: Re: AGS Wiki Updates/Discussion
Post by: AGA on Tue 01/06/2021 21:14:52
Back now!  I've upgraded it to the latest version, please do let me know if anything seems to be broken!

I also installed a mobile friendly extension + skin combo, which should render a more streamlined version of the wiki on mobile devices.
Title: Re: AGS Wiki Updates/Discussion
Post by: Hobbes on Tue 01/06/2021 23:18:27
Thanks for doing that AGA!

Can I request the following extension is installed:

https://m.mediawiki.org/wiki/Extension:FontAwesome (https://m.mediawiki.org/wiki/Extension:FontAwesome)

It'll help to provide some simple GUI styling to certain areas which should help with legibility.

Thank you!
Title: Re: AGS Wiki Updates/Discussion
Post by: Hobbes on Tue 01/06/2021 23:20:15
And back again. Just tried to update a page, but I get:

"Server returned error: HTTP 500." whilst the Editing interface is loading. So I can't edit any of the pages anymore at the moment.

When I finally click "Cancel" on the Editing interface, I get:

[4cdfdf16b272a0eba70ff04a] 2021-06-01 22:19:45: Fatal exception of type "Error"

or

[d06e65e8d1ae1e2f55010249] 2021-06-01 22:24:55: Fatal exception of type "Error"

Similarly, whilst logged in, clicking on Preferences at the top of the screen gives this:

[4c6121973a8d5605822a1ce1] 2021-06-01 22:23:34: Fatal exception of type "Wikimedia\Rdbms\DBQueryError"
Title: Re: AGS Wiki Updates/Discussion
Post by: AGA on Wed 02/06/2021 18:35:38
Should be fixed now!  I had some left over config from an older version of an extension that was causing mischief.  Please do confirm that you're now able to edit successfully.
Title: Re: AGS Wiki Updates/Discussion
Post by: Hobbes on Thu 03/06/2021 09:44:04
Yup - it's working perfectly now, thanks for fixing it!

Did you also manage to install the FontAwesome extension? (I'm not sure how to check this myself :))
Title: Re: AGS Wiki Updates/Discussion
Post by: Hobbes on Thu 03/06/2021 10:49:18
Just tried to add a graphic to the front page (the nice AGS cup) to bring some graphical interest to the whole thing. But either I don't have permission to upload things into the Wiki, or there's a bug still lingering around somewhere... :)

(https://www.jaapmarsman.com/img/wiki_error.png)
Title: Re: AGS Wiki Updates/Discussion
Post by: AGA on Thu 03/06/2021 11:29:25
I've fixed that, it was a permissions issue on the server.

https://www.mediawiki.org/wiki/Extension:FontAwesome#Usage <- I installed the FontAwesome extension; please see here for the markup.  If you're curious, you can see a list of the installed extensions and their versions here: https://www.adventuregamestudio.co.uk/wiki/Special:Version.
Title: Re: AGS Wiki Updates/Discussion
Post by: eri0o on Thu 03/06/2021 11:34:50
AGA, more sort of a question, on the forums, it's possible to show images hosted elsewhere. Is there a way to do the same on the Wiki? Some external websites allows rendering information in an API that returns an image, I wanted to add one page with one of those, but could not figure it out.
Title: Re: AGS Wiki Updates/Discussion
Post by: AGA on Thu 03/06/2021 11:49:20
Offsite hosting isn't necessarily the best idea though, if you have the option of hosting locally. Offsite hosting is less likely to always be available than something we have a local copy of, after all. What sort of images are you talking about?
Title: Re: AGS Wiki Updates/Discussion
Post by: eri0o on Thu 03/06/2021 12:17:46
Badges and similars. (it's alright not supporting, just curious)
Spoiler
(https://repology.org/badge/vertical-allrepos/ags-adventuregamestudio.svg)
[close]
Title: Re: AGS Wiki Updates/Discussion
Post by: Hobbes on Thu 03/06/2021 12:47:18
AGA, thank you yet again! I sent a brief PM with some additional small requests.

In the meantime, I've added a new page to the AGS Community area, indicating ways for people to help out. It's available here: https://www.adventuregamestudio.co.uk/wiki/Ways_to_contribute (https://www.adventuregamestudio.co.uk/wiki/Ways_to_contribute)

Please everyone, have a read and feel free to edit where appropriate (I'm not 100% how helping development is handled, for example).
Title: Re: AGS Wiki Updates/Discussion
Post by: Hobbes on Mon 14/06/2021 12:50:47
Right, the past few weeks have been relatively quiet - but I've continued to tidy up minor areas here & there. The main page has had the biggest "make over" using FontAwesome icons to try and increase readability. Love the fact that the latest Wiki version ready so well on mobile.

The coding conventions AGS Wiki page can probably be removed, since a more actively maintained version is on the GitHub Wiki, so I've pointed towards there instead.

I also want to put this notion of "AGS is for hobbyists" to bed. So I made a start with a "Why choose AGS (https://www.adventuregamestudio.co.uk/wiki/Why_AGS)" style page. Feel free to edit/adapt/link stuff in there.

I'll keep plodding away on this Wiki thing... there's a lot of cobwebs there! :)
Title: Re: AGS Wiki Updates/Discussion
Post by: Crimson Wizard on Tue 15/06/2021 23:03:02
Something that may be important to mention in the introduction, or some "troubleshooting" FAQ section: antiviruses don't like AGS for some reason, especially Avast (based on experience). A lot of people had issues with an antivirus or Windows Defender blocking editor or their games, causing them to stop working or not perform some action.
Title: AGS Wiki Updates/Discussion
Post by: Hobbes on Wed 16/06/2021 12:18:31
Yeah, I could add that to the FAQ somewhere - that's a bit odd though. Are people still reporting this issue using Windows 10 + Windows Defender? I've had numerous Windows systems using AGS and never ran into this issue. So I'd like to carefully phrase it that they might want to switch over to a modern version of the OS if they want to avoid this issue? (If it is more of a Windows 7/8/8.1 thing, perhaps?)
Title: Re: AGS Wiki Updates/Discussion
Post by: eri0o on Thu 17/06/2021 22:57:52
Hobbes, one thing would be cool to add is a meta page on the wiki about contributing to the wiki - like mentioning interesting things to add to the wiki and maybe a bit on how to do upkeep.

Oh, I found it, you already added, it's here: https://www.adventuregamestudio.co.uk/wiki/AGS:About !  :-D

I noticed the pages you edited the wiki looks better too, but I don't know why.
Title: Re: AGS Wiki Updates/Discussion
Post by: tampie85 on Thu 24/06/2021 12:50:13
Hobbes,

Would you mind adding a few items that currently live on the website to an appropriate location on the Wiki and make sure the content is up to date?

EDIT: never mind


I discussed this list with AGA, so it should make sense. Please let me know if you disagree or rather not add it to the wiki.
Title: Re: AGS Wiki Updates/Discussion
Post by: Snarky on Thu 24/06/2021 13:11:10
If I could comment…

All the tutorial stuff is from the manual. Maybe link there instead of duplicating it on the Wiki?
The poll stuff has no current relevance. I suggest it should simply be deleted. (Though it would be nice if it was archived for historical interest.)
As for the plugin instructions, I'm a bit leery of putting it in the Wiki. I think it belongs in the manual (preferably), or alternatively as documentation on Github. (I think I mentioned this before.)
Title: Re: AGS Wiki Updates/Discussion
Post by: tampie85 on Thu 24/06/2021 14:28:56
Oops... sorry, small misunderstanding with AGA. With 'Wiki' he meant it should live somewhere where it can be maintained by the community.

By all means, don't duplicate data. Do you have a link to the manual? Happy to add it somewhere in the redesign.

Who should I ask to add stuff to the manual, to make sure it doesn't get lost?

As for the stuff with no current relevance, AGA says he doesn't want to delete anything and that it should be kept somewhere for historical interest.
I don't think it should live somewhere on the site? Or do you disagree?
Title: Re: AGS Wiki Updates/Discussion
Post by: Crimson Wizard on Thu 24/06/2021 14:40:39
Quote from: tampie85 on Thu 24/06/2021 14:28:56
Who should I ask to add stuff to the manual, to make sure it doesn't get lost?

Manual source is here: https://github.com/adventuregamestudio/ags-manual
You may open a TODO issue, with links to original material, for example.
The manual is edited like wiki, using markdown: https://github.com/adventuregamestudio/ags-manual/wiki

Quote from: Snarky on Thu 24/06/2021 13:11:10
As for the plugin instructions, I'm a bit leery of putting it in the Wiki. I think it belongs in the manual (preferably), or alternatively as documentation on Github. (I think I mentioned this before.)

Here's the related issue: https://github.com/adventuregamestudio/ags-manual/issues/134
There's a Editor plugin page almost ready (https://github.com/adventuregamestudio/ags-manual/wiki/AGS-Editor-Plugins), except for the images, because i did not know how to insert them into markdown there (need to ask morganw or eri0o):
For the engine plugin API someone has to do a good effort and transfer an article into markdown format.
Title: Re: AGS Wiki Updates/Discussion
Post by: eri0o on Thu 24/06/2021 21:38:44
CW, I will add but I will try to make new ones with VS2019 or VS2022. The current images use some incarnation of VS that is my age or something...

There's an open PR that documents along other things how to add images, still need to streamline it with Morgan before adding it.
Title: Re: AGS Wiki Updates/Discussion
Post by: Hobbes on Fri 25/06/2021 00:17:58
Quote from: tampie85 on Thu 24/06/2021 12:50:13
Hobbes,

Would you mind adding a few items that currently live on the website to an appropriate location on the Wiki and make sure the content is up to date?

EDIT: never mind


  • https://www.adventuregamestudio.co.uk/site/ags/plugins/editor/ (https://www.adventuregamestudio.co.uk/site/ags/plugins/editor/)
  • https://www.adventuregamestudio.co.uk/site/ags/plugins/engine/ (https://www.adventuregamestudio.co.uk/site/ags/plugins/engine/)
  • https://www.adventuregamestudio.co.uk/site/ags/polls/ (https://www.adventuregamestudio.co.uk/site/ags/polls/)
  • https://www.adventuregamestudio.co.uk/site/ags/tutorial/ags/1/ (https://www.adventuregamestudio.co.uk/site/ags/tutorial/ags/1/)
  • https://www.adventuregamestudio.co.uk/site/ags/tutorial/ags/2/ (https://www.adventuregamestudio.co.uk/site/ags/tutorial/ags/2/)
  • https://www.adventuregamestudio.co.uk/site/ags/tutorial/ags/3/ (https://www.adventuregamestudio.co.uk/site/ags/tutorial/ags/3/)
  • https://www.adventuregamestudio.co.uk/site/ags/tutorial/ags/4/ (https://www.adventuregamestudio.co.uk/site/ags/tutorial/ags/4/)
  • https://www.adventuregamestudio.co.uk/site/ags/tutorial/ags/5/ (https://www.adventuregamestudio.co.uk/site/ags/tutorial/ags/5/)
  • https://www.adventuregamestudio.co.uk/site/ags/tutorial/ags/6/ (https://www.adventuregamestudio.co.uk/site/ags/tutorial/ags/6/)
  • https://www.adventuregamestudio.co.uk/site/ags/tutorial/ags/7/ (https://www.adventuregamestudio.co.uk/site/ags/tutorial/ags/7/)
  • https://www.adventuregamestudio.co.uk/site/ags/tutorial/ags/8/ (https://www.adventuregamestudio.co.uk/site/ags/tutorial/ags/8/)
  • https://www.adventuregamestudio.co.uk/site/ags/tutorial/ags/9/ (https://www.adventuregamestudio.co.uk/site/ags/tutorial/ags/9/)
  • https://www.adventuregamestudio.co.uk/site/ags/tutorial/gui/1/ (https://www.adventuregamestudio.co.uk/site/ags/tutorial/gui/1/)
  • https://www.adventuregamestudio.co.uk/site/ags/tutorial/gui/2/ (https://www.adventuregamestudio.co.uk/site/ags/tutorial/gui/2/)
  • https://www.adventuregamestudio.co.uk/site/ags/tutorial/scripting/1/ (https://www.adventuregamestudio.co.uk/site/ags/tutorial/scripting/1/)
  • https://www.adventuregamestudio.co.uk/site/ags/tutorial/scripting/2/ (https://www.adventuregamestudio.co.uk/site/ags/tutorial/scripting/2/)
  • https://www.adventuregamestudio.co.uk/site/ags/ (https://www.adventuregamestudio.co.uk/site/ags/) (only the resources area)


I discussed this list with AGA, so it should make sense. Please let me know if you disagree or rather not add it to the wiki.

Hi Tampie, of course! It's been a bit crazy at work this week but I'll have a go at it this weekend. I'll look at Snarky's comment too and see if there's a lot of overlap between these website pages & the manual on GitHub and post back here in more detail.
Title: Re: AGS Wiki Updates/Discussion
Post by: tampie85 on Fri 25/06/2021 12:20:14
Quote from: Hobbes on Fri 25/06/2021 00:17:58
Hi Tampie, of course! It's been a bit crazy at work this week but I'll have a go at it this weekend. I'll look at Snarky's comment too and see if there's a lot of overlap between these website pages & the manual on GitHub and post back here in more detail.

Awesome! Would you mind creating the tickets for the manual too, as CW suggests? You probably know exactly what to request, while I'm not so much into the details of the documentation.
Title: AGS Wiki Updates/Discussion
Post by: Hobbes on Sat 26/06/2021 05:42:12
Hi all,

I've done the following:

- Opened a GitHub Issue concerning the Tutorial pages for the AGS Manual Wiki.
- Transferred the Polls to the AGS History part of the AGS Wiki.
- Transferred the Resources part to the "Getting Started Resources" page on the AGS Wiki. Can do with some cleaning up but functional for now.

I'm just now fully understanding the AGS Manual Wiki on GitHub. I think this is a Site Design suggestion, but I'll post it here anyway. Tampie85/AGA, would it be possible to have a more prominent link to the GitHub AGS Manual link on the main website? But rather than just cold-linking to GitHub, would it be possible for you to set up an account on https://readthedocs.org and link to GitHub from there?

I could set up the account on readthedocs as well, but since you'll be doing site-hosting/maintenance, I think it makes more sense you control this link. ReadTheDocs will pull live from GitHub anyway. But it'll help increase readability for outside / new users. I know I keep pointing out Godot as an example, but I do think they've done this quite well:

https://docs.godotengine.org/en/stable/?

Eager to hear what everyone thinks.

Moving forward, the AGS Wiki can then really become a repository for historical / wimsical things on one end and non-technical articles on the other (focused on game design, etc). My summer holiday is due to begin (the joys of being in education) so I'm looking forward to writing a larger tutorial for that place. :)
Title: Re: AGS Wiki Updates/Discussion
Post by: eri0o on Sat 26/06/2021 11:22:30
Hobbes, we purposedly don't use read the docs, the wiki is auto updated here:

https://adventuregamestudio.github.io/ags-manual/

The wiki on GitHub also is used for the generation of the version that is with the software.

Here's the continuous integration system we use for automation: https://github.com/adventuregamestudio/ags-manual/actions

We usually simply create a release after a few updates.

If you want, simply ask what you don't understand in the help system. The system is written using Pandoc and Lua, the reason being some things have special meaning on the AGS IDE, like people want to be able to select a code and hit F1 to get that piece of AGS standard API doc from the manual. It also needs to figure out additional info...

The reason it's not fully instantaneous per wiki update is that the manual wiki is completely open (everyone on the internet can write in it), we NEVER had irregular edits on the wiki, but I thought it was better to err in the side of caution, since the resulting text gets shipped with AGS.

Here's a bit of history:
https://www.adventuregamestudio.co.uk/forums/index.php?topic=56432.0

Also when making the theme there I think in the less fully featured browsers, since I imagine eventually we will modify AGS to have a web view and the manual pages will be in HTML form there - haven't needed yet to transition since support for the CHM in the .NET haven't been removed.

We also tried a ton of already existing tools for parsing the manual into it's html/chm forms, but they all had SOME problem that was unfixable, so after a while we settled on writing our tooling. Morgan did the work for the current Pandoc+Lua generator.
Title: AGS Wiki Updates/Discussion
Post by: Hobbes on Sat 26/06/2021 11:35:18
Aaaah, yes, I should've probably noticed that. I had already updated the Wiki link to that Manual page but didn't realise it was a fully rendered front end. Forget what I said about readthedocs. :-)
Title: AGS Wiki Updates/Discussion
Post by: Hobbes on Sun 27/06/2021 03:13:59
The Resources area from the AGS download page is now fully transferred to the Wiki:

https://www.adventuregamestudio.co.uk/wiki/Getting_Started_Resources

The SCI Fonts took a bit of manual copying-and-uploading-and-pasting to get all the GIF files to pop over.

The Font Pack (.zip file) is still linking to the AGS website version. This is because MediaWiki does not allow you to upload ZIP files.