[Dev Thread] Enhanced Thief Fan Missions Archive (Last update: 2017/12/24) - by EnYB0La
EnYB0La on 18/12/2017 at 14:41
Quote Posted by Wizd3m
This is super cool, and looks very well organized! I'm wondering if you'll be including links to various written reviews for FMs/Campaigns found on the web. I needed a good reason to get back into writing, and would love to support the project the best way I know how. No worries if that's not in the plan, I'm mostly just curious and excited that this is happening :D
Well, as you advised me, I added a new YAML key in order to incorporate this kind of information. Thanks.
Quote Posted by FenPhoenix
Actually I was kind of waiting to see what you decided to do with campaigns before starting with detecting them. Detecting a campaign shouldn't be too hard, I can just see if there are multiple .mis files and then check titles.str to see if there are multiple non-stock mission names in there to be sure. Pulling individual descriptions from the readme is an iffier proposition, but I'll still give it a shot cause I'm game.
(
https://image.ibb.co/icsDH6/1.png) My last preview, is my last option. One page for a Thief Campaign, as Yandros advised me. I'll surely tweak it but I think I have a great template base. I'll add "Similar Fan Missions" section at the bottom.
Quote Posted by FenPhoenix
Even if I can't do it fully automatically, I may be able to
make it quicker to copy-paste manually with maybe some auto-formatting help or something (cause a lot of descriptions have slightly wacky formatting that looks fine when displayed in DarkLoader but needs finagling when you want to paste it elsewhere, I know from pasting a lot of readme text into YouTube video descriptions :p)
We should be aware about this problem because the Fan Mission will be described in Markdown, with an entire different language syntax. So the formatted texts cannot be copy-pasted as they are in README... and weird characters should be avoided.
Impressive Fen!! Yeah, you definitely should create your own thread in order to promote your work. It's amazing. I didn't think you were working on a GUI.
Maybe as a future improvement: replace the "Open YAML" button by an "Export to.." one with "YAML", "JSON" and "XML" as available options.
I have changed some things in YAML archetype. We should work together in order to define them and coordinate the changes between our two applications:
Code:
draft: true
title: ""
author:
name: ""
ttlgpropfileid: ""
type: "fanmission"
includedmissions: ""
details:
game: ""
ttlgthread:
title: ""
id: ""
category: ""
contest:
name: ""
url: ""
languages:
- ""
version: ""
newdark:
isrequired: false
minrequiredversion: ""
originalreleasedate: ""
lastupdatedate: ""
characteristics:
hascustomgamesys: false
hascustomscripts: false
hascustomtextures: false
hascustomsounds: false
hascustomobjects: false
hascustomcreatures: false
hascustommotions: false
hasautomap: false
hasmovies: false
hasmap: false
extras:
download:
main:
sourcename: ""
url: ""
mirrors:
- sourcename: ""
url: ""
screenshots:
sourcename: ""
urls:
- ""
youtube:
videoid: ""
author:
name: ""
channelid: ""
reviews:
- sourcename: ""
url: ""
walkthroughs:
- sourcename: ""
url: ""
lootlists:
- sourcename: ""
url: ""
I'm not sure about this part. I think I'll rework it:
Code:
type: "fanmission"
includedmissions: ""
can have two values:
fanmission and
campaignIf the value is campaign, so the
includedmissions key should indicate the number of available FMs included in the campaign.
You can see the Git diff here: (
https://github.com/etfma/etfma-website/commit/d159967aaf4b385dd8692582959ba7b28da882f4)
FenPhoenix on 18/12/2017 at 15:50
Quote Posted by EnYB0La
We should be aware about this problem because the Fan Mission will be described in Markdown, with an entire different language syntax. So the formatted texts cannot be copy-pasted as they are in README... and weird characters should be avoided.
Right, I forgot about that. I'll remember to convert it to valid Markdown.
Quote Posted by EnYB0La
Impressive Fen!! Yeah, you definitely should create your own thread in order to promote your work. It's amazing. I didn't think you were working on a GUI.
Maybe as a future improvement: replace the "Open YAML" button by an "Export to.." one with "YAML", "JSON" and "XML" as available options.
Thanks. Actually the interface is basically "dev garbage" right now, it's just to let me do whatever I need to do, and I'm just throwing whatever I need on there. Once I start getting things more complete and nailed down, I'll rework the UI to be more user friendly and make more sense.
But Hugo doesn't support XML, right? It (
https://gohugo.io/templates/data-templates/) says "YAML, JSON and TOML". Sadly I need to take a dependency for any of those (but not XML), but ah well.
Quote Posted by EnYB0La
I have changed some things in YAML archetype. We should work together in order to define them and coordinate the changes between our two applications:
Code:
draft: true
title: ""
author:
name: ""
ttlgpropfileid: ""
type: "fanmission"
includedmissions: ""
details:
game: ""
ttlgthread:
title: ""
id: ""
category: ""
contest:
name: ""
url: ""
languages:
- ""
version: ""
newdark:
isrequired: false
minrequiredversion: ""
originalreleasedate: ""
lastupdatedate: ""
characteristics:
hascustomgamesys: false
hascustomscripts: false
hascustomtextures: false
hascustomsounds: false
hascustomobjects: false
hascustomcreatures: false
hascustommotions: false
hasautomap: false
hasmovies: false
hasmap: false
extras:
download:
main:
sourcename: ""
url: ""
mirrors:
- sourcename: ""
url: ""
screenshots:
sourcename: ""
urls:
- ""
youtube:
videoid: ""
author:
name: ""
channelid: ""
reviews:
- sourcename: ""
url: ""
walkthroughs:
- sourcename: ""
url: ""
lootlists:
- sourcename: ""
url: ""
I'm not sure about this part. I think I'll rework it:
Code:
type: "fanmission"
includedmissions: ""
can have two values:
fanmission and
campaignIf the value is campaign, so the
includedmissions key should indicate the number of available FMs included in the campaign.
I note that "ttlgpropfileid" should presumably be "ttlgprofileid". For the longest time I was wondering what a "prop file" is. :p
Another thing is, if you look on the (
http://thiefmissions.com/search.cgi?search=&sort=release) thiefmissions.com list for example, some missions have Hints links. Only about 30 or so of them have such links, but we could add a "hints" value nevertheless.
To everyone reading, what do you think about the custom gamesys and custom everything else stuff? Is this important and/or relevant? It'd be good to get popular opinion on this point. Or maybe we ask for feedback during the public beta period?
Another thing I thought of is that some missions have separate downloads for different languages, (
http://www.ttlg.com/forums/showthread.php?t=148371) Death's Cold Embrace being a recent example. We'll have to take that into account, as we'd have to have different download links for different languages and a way to note that on the page. Could put them in the Mirrors dropdown, but then they're a bit hidden and it isn't immediately obvious that one needs to download a separate file for other languages. Or else have separate pages for the different versions in that case, but that seems kinda inconsistent.
One more thing I can think of, is that there are missions which aren't technically a campaign (ie, they're separate releases) but which are part of the same "story", like for example Ominous Bequest & Broken Triad, the Rocksbourg series, the Love Story series, etc. It may be nice to have an easy way to let people click onto other missions in the same "series but not campaign". Not sure about the details of this and I'm dead tired right now so hoypadoyp. Anyway, that's all I can think of right now, the rest looks good to me.
skacky on 18/12/2017 at 16:04
I don't think custom gamesys is worthwhile; 99% of released missions have a custom gamesys anyway, even those that use stock resources only. Custom everything else however is a good indicator and should be listed (but as said before, custom Books and Goals should be omitted).
EnYB0La on 18/12/2017 at 17:04
Quote Posted by FenPhoenix
But Hugo doesn't support XML, right? It (
https://gohugo.io/templates/data-templates/) says "YAML, JSON and TOML". Sadly I need to take a dependency for any of those (but not XML), but ah well.
I was wondering if we could use your app, not only with Hugo, but as a standalone one where users could list their downloaded FM and get details of theml. So, yeah IMHO, it could be a great feature to be able to export this database to JSON, YAML and XML. And maybe TOML. In my case, I'll use YAML as a reference to my web app.
Quote Posted by FenPhoenix
I note that "ttlgpropfileid" should presumably be "ttlgprofileid". For the longest time I was wondering what a "prop file" is. :p
Fixed :p
Quote Posted by FenPhoenix
Another thing is, if you look on the (
http://thiefmissions.com/search.cgi?search=&sort=release) thiefmissions.com list for example, some missions have Hints links. Only about 30 or so of them have such links, but we could add a "hints" value nevertheless.
I'll create a new YAML key.
Code:
extras:
hints:
- sourcename: ""
url: ""
Quote Posted by FenPhoenix
To everyone reading, what do you think about the custom gamesys and custom everything else stuff? Is this important and/or relevant? It'd be good to get popular opinion on this point. Or maybe we ask for feedback during the public beta period?
I was thinking about this kind of stuff yeah. I'm not really sure if it is really a relevant information. And yes, I think, we should get popular opinion about that during the public Beta period.
Quote Posted by FenPhoenix
Another thing I thought of is that some missions have separate downloads for different languages, (
http://www.ttlg.com/forums/showthread.php?t=148371) Death's Cold Embrace being a recent example. We'll have to take that into account, as we'd have to have different download links for different languages and a way to note that on the page. Could put them in the Mirrors dropdown, but then they're a bit hidden and it isn't immediately obvious that one needs to download a separate file for other languages. Or else have separate pages for the different versions in that case, but that seems kinda inconsistent.
I'll have to think about it and rework this part. Maybe, using a dropdown list (with an arrow button) added to the main Download button with available language options?
Quote Posted by FenPhoenix
One more thing I can think of, is that there are missions which aren't technically a campaign (ie, they're separate releases) but which are part of the same "story", like for example Ominous Bequest & Broken Triad, the Rocksbourg series, the Love Story series, etc. It may be nice to have an easy way to let people click onto other missions in the same "series but not campaign". Not sure about the details of this and I'm dead tired right now so hoypadoyp. Anyway, that's all I can think of right now, the rest looks good to me.
We could create a new YAML key in order to reference those FM to the current viewed one. I'll work too in this case and I'll notice you when I'll get more worked stuff. Added to my TODO list :)
Quote Posted by skacky
I don't think custom gamesys is worthwhile; 99% of released missions have a custom gamesys anyway, even those that use stock resources only. Custom everything else however is a good indicator and should be listed (but as said before, custom Books and Goals should be omitted).
I decided to delete this YAML key. Thanks :)
The current Fan Mission Single Page Template Sidebar:
Inline Image:
https://image.ibb.co/kktnUm/Sidebar.pngWizd3m on 18/12/2017 at 23:04
Quote Posted by EnYB0La
Well, as you advised me, I added a new YAML key in order to incorporate this kind of information. Thanks.
Thank you so much, EnYB0La :)
EnYB0La on 20/12/2017 at 00:53
2017/12/19A concrete example with a Fan Mission.
(
https://image.ibb.co/fetZS6/Single_Page_Template_for_Fan_Mission.png)
Inline Image:
https://preview.ibb.co/mxzkZm/Single_Page_Template_for_Fan_Mission.pngAnd also, I modified the default YAML front-matter:
Code:
draft: true
title: ""
author:
name: ""
ttlgprofileid: ""
type: "fanmission"
includedmissions: ""
details:
game: ""
ttlgthread:
title: ""
id: ""
category: ""
contest:
name: ""
url: ""
languages:
- ""
version: ""
newdark:
isrequired: false
minrequiredversion: ""
originalreleasedate: ""
lastupdatedate: ""
characteristics:
hascustomscripts: false
hascustomtextures: false
hascustomsounds: false
hascustomobjects: false
hascustomcreatures: false
hascustommotions: false
hascustomsubtitles: false
hasautomap: false
hasmovies: false
hasmap: false
extras:
download:
main:
hoster:
name: ""
websiteurl: ""
items:
- language: ""
size: ""
url: ""
alternative:
hoster:
name: ""
websiteurl: ""
items:
- language: ""
size: ""
url: ""
screenshots:
source:
name: ""
websiteurl: ""
items:
- ""
youtube:
videoid: ""
youtuber:
name: ""
channelid: ""
reviews:
- sourcename: ""
url: ""
walkthroughs:
- sourcename: ""
url: ""
lootlists:
- sourcename: ""
url: ""
hints:
- sourcename: ""
url: "
The Git Diff: (
https://github.com/etfma/etfma-website/commit/eabba0ab029b1c14c31a382ac5b604f7ab09ad8c?diff=split)
FenPhoenix on 20/12/2017 at 04:17
Looking pretty good.
Couple thoughts:
I think the "How to install a fan mission" link should be close to the Download button, like maybe right above it even. I had to look around for it when you mentioned you added it; my eye tends to ignore the top part above the header image and just scan from the header image down. Plus the button is in very low-key grey so I think it's easy to miss. If it were right above the Download button, even just a regular blue text link like the Hoster link, then I think people wouldn't miss it when they go to download. That's my train of thought, anyway; I think "download" first, but maybe other people would look for a "how to" first, I don't know. But it could definitely stand to be easier to find, and as I said, the top bar tends to look like noise to me (top and bottom bars on sites tend to say to me "this is random header/footer stuff you don't care about, so not important") so I don't really look there first.
On the other side, I think the NewDark badge could stand to have its colors more muted; red is a really attention-grabbing, warning/error/something's-wrong kind of color, and it draws my eye too much. Plus the red-on-white text can be a little hard to read when surrounded by the darker backdrop. I think a different color, or even just greyscale might work well.
I notice on the right side, you've got "NewDark: * [version]" and then "* minimum required version" at the bottom. I think it'd be better to just say "NewDark minimum required version: [version]" or similar without the asterisk text at the bottom. It'd be tidier and one less flick of the eye.
Finally, I still think it should be made clearer if an alternate download is required in order to get a certain language. I'm just not quite sure, I just feel like it should be immediately clear if you need an alternate download or not, but not sure how I would suggest doing it. I do have a few ideas... maybe I'm overthinking it. But I'd like to do a few mockups later to try some different things out and then show them here for feedback.
Anyway, it's coming along nicely, so good work.
Oh, and one other thing: some missions have multiple authors, so maybe we can add that.
EnYB0La on 22/12/2017 at 14:24
Quote Posted by FenPhoenix
I think the "How to install a fan mission" link should be close to the Download button.
Inline Image:
https://image.ibb.co/hQo6S6/Download_button.pngQuote Posted by FenPhoenix
On the other side, I think the NewDark badge could stand to have its colors more muted; red is a really attention-grabbing, warning/error/something's-wrong kind of color, and it draws my eye too much. Plus the red-on-white text can be a little hard to read when surrounded by the darker backdrop. I think a different color, or even just greyscale might work well.
I redesigned this badge but I prefer the red one because it has to alert the player he needs that NewDark minimum required version in order to be able to play the viewed FM. People reading this, what do you think about this decision?
Inline Image:
https://image.ibb.co/jjaxZm/New_Dark_badges.pngQuote Posted by FenPhoenix
I notice on the right side, you've got "NewDark: * [version]" and then "* minimum required version" at the bottom. I think it'd be better to just say "NewDark minimum required version: [version]" or similar without the asterisk text at the bottom. It'd be tidier and one less flick of the eye.
I'm not sure about this... I applied what you mentioned me but I think the text is too long. Maybe should I use a tooltip and a ? icon instead of an asterics character..?
Inline Image:
https://image.ibb.co/m9aQLR/unknown.pngQuote Posted by FenPhoenix
Finally, I still think it should be made clearer if an alternate download is required in order to get a certain language. I'm just not quite sure, I just feel like it should be immediately clear if you need an alternate download or not, but not sure how I would suggest doing it. I do have a few ideas... maybe I'm overthinking it. But I'd like to do a few mockups later to try some different things out and then show them here for feedback.
Waiting for your mockups to get an idea :)
Quote Posted by FenPhoenix
Oh, and one other thing: some missions have multiple authors, so maybe we can add that.
What FM can I use to inspire me and to have a concrete reference?
Yandros on 22/12/2017 at 20:05
Waterfront Racket was by me and Tannar, and The Drymian Codex was me, Random_Taffer and Tannar.
