Modding Documentation Site

[lusty marsh]

The documentation for modding tends to be all over the place so I'd like work on one consistent site for guides.
https://animatedswine37.github.io/persona-modding-docs/ is my current version

My plan is to use Jekyll hosted on GitHub pages. This has the advantage of making all documentation open source, and as such open to contributions from the community. I hope this fact will give the project some chance of success as everything won't necessarily be in the hands of a single person.

I don't intend this to be a replacement for the Amicitia wiki, instead the two should complement each other. The site will focus on practical guides, walking a person through the steps of the modding process, whilst the wiki is more for hosting information for people who already know what they're doing.

I plan to personally write on:

• The basics (extracting files, formatting a mod, publishing)
• Editing text (bmds)
• Editing scripts (bfs)
• Editing binary files with 010
• Editing sprites
• Maybe some reverse-engineering stuff/code mod stuff

I hope others could contribute guides on:

• Replacing music
• Replacing videos
• Importing models

I'm currently very early on in this, I've spent a few hours over the past few days working on a general layout and a few initial pages in the Getting Started section.
I don't plan on rapidly working on this like I usually do with my projects, instead I'll try and do a little bit every few days, hopefully that'll stop me from getting bored of the idea. The fact that it's now semi-public knowledge that this exists will hopefully also help 😄

I've previously partly written two guides (a flowscript and a reverse-engineering one) which will never see the light of day because I got bored after a few days, I really hope that doesn't become the case with this...

[orchid orbit]

making more information available to people who want to learn to mod these games is never a bad thing, I've wanted to see some sort of collection of guides for a while now, so this is great to see - hopefully having other people help also helps you to be able to commit more to this without getting bored haha

Music replacement is pretty easy for P3P and P4G. I think it's pretty easy for P5R and P3F too but I haven't tried replacing music for those games so I'm not 100% sure. Either way, once I get back from my trip, I can contribute something there

[broken kindle]

p5r music replacement is pretty much "drop the file into awb emulator," apart from some rare instances like cbt that demand repacking the whole awb

[rustic crag]

right as i start working on my own guides 😔

i’m down to contribute some of my guides so it’s all in one place though

though we’ll probably need someone to rewrite it for blender since blender is free and 3DS max isn’t

[trim shell]

Sounds great.
I can make a PR for Blender stuff after I've got the next update done

[lusty marsh]

Yeah, that'd be awesome. I'll add a page on how to contribute later today, basically it's just markdown plus a bit extra for some of the fancier stuff

[rustic crag]

anyone know how to convert a gitbook page into markdown?

i just spent 30 minutes converting one of my pages into markdown, tried to make a push request, and completely overwrote the file with the original, losing all my changes

[lusty marsh]

You can export to pdf but I don't see a markdown option 😦

There's this, no idea if it actually works though
https://github.com/conversation/gitbook-to-md

[rustic crag]

pdf means i have to pay for premium

[lusty marsh]

bruh

This is why I'm avoiding gitbook lol

[rustic crag]

npm seemingly only works on linux

[lusty marsh]

I don't want the documentation to end up locked away behind a paywall

You can install npm on windows, it might be a bit harder than doing it on linux though

[rustic crag]

so i'm screwed huh

all my info is stuck on gitbook

[lusty marsh]

Have you tried just copy pasting the pages and doing any changes by hand? I don't think it'd be that hard

[rustic crag]

i had to go in and redo everything basically

basically everything

all of my embeds, all tables, all bolds, all indents, everything

took 30 minutes

and then when i went to push it to my github?

i did and noticed, it overwrote my saved file

and i lost all of my changes

i'm not doing that ever again

[lusty marsh]

I see, I don't really understand how you'd lose everything like that but ok

[rustic crag]

anything that wasn't just plain text, didn't get inserted

alright well

you can sorta export as md

https://github.com/BonQerss/gitbook-docs-for-p4g-mods

little jank in some parts

all that's really done is P5R models and SMT V models

[lusty marsh]

That took quite a while but there's now some pretty comprehensive (arguably overkill) documentation on how to contribute to the docs 🙂
https://animatedswine37.github.io/persona-modding-docs/contributing/contributing.html

It assumes basically no knowledge at all so I think anyone should be able to work with it, whether they've worked with GitHub or Jekyll before or not

Of course that does mean there will be bits (like how to fork a repo and make a commit) that lots of people will be able to completely skip over

[olive cliff]

thanks for setting all of this up! one of the biggest issues with persona modding rn is just the lack of good info so this'll be a huge boon for the community

[lusty marsh]

I really hope that comes true, there's still tons of writing to do before it's really useful for users though

[olive cliff]

yeah i think it'll def happen though

btw i'd like to contribute some of what i know about evt files so would i document that under binary files?

[lusty marsh]

I think it'd be better if you just made another section for that called events. My intention for binary files was more for things like tbls

[olive cliff]

[orchid orbit]

this is something i've wanted for so so long so thanks for getting something set up here.
thanks bonq for the stuff you'd already done too, i didn't know it was a thing until you brought it up 😭

[orchid orbit]

probably good to specify the game too haha since iirc it works differently for p4, p3f, and p3p

[rustic crag]

i'm just surprised there isn't more up to date documentation on this stuff

like i'm still surpirised that me of all people figured out there's still 2 unused persona slots you can add

[lusty marsh]

Yeah, P5 uses a completely different system for events

[orchid orbit]

it always did bother me bc there were several things that i had to find by doing a ctrl+f search in this server to find messages from 2021

hahaha

[rustic crag]

tell me about it

you'll be reading messages and then the guy goes "ope figured it out thanks y'all" and that's it

[orchid orbit]

lmao or just nothing beyond that

well, we have some knowledge now so hopefully we can pass it on. at least for me i'm sure i'll learn some stuff from it too haha

[rustic crag]

i'm pretty excited to learn about the flowscript documentation

there's a few things i wanted to try and make in flowscript but had zero idea where to start

[lusty marsh]

I don't see any reason not to

[rustic crag]

we really need more people to PR their templates actually

[lusty marsh]

Once there's a fair amount of stuff we might need to do some reorganising to keep everything neat but for now there isn't much so it doesn't matter too much

True...

[rustic crag]

i love juggling 6 different versions of p4g_tbl.bt and their enums + structs 😍

another thing

god bless the people who actually code

this markdown stuff is boggling my mind and it's literally just typing

[lusty marsh]

Yeah, it's really cool how easy it is to make documentation that looks fairly good. The Just the Docs template the site uses is awesome

[rustic crag]

slowly getting the hang of it

still need to figure out how to add image captions like before

[lusty marsh]

Nice

It seems like there isn't really a standard way to do that, there are a fair few suggestions in this stack overflow page, maybe even just go with html like you probably had before.
What's best would depend on how often you use captions, if it's something you use regularly a plugin or something might be nicer than the full html
https://stackoverflow.com/questions/19331362/using-an-image-caption-in-markdown-jekyll

I'm not too bothered by which way you go about it as long as it works

[rustic crag]

yeah i got it worked out

you should probably add a mini section for adding code copying to the documentation

super simple just three ' above and below a command

[lusty marsh]

That's just standard markdown but if you think it's important enough you could just add a bit on it yourself

[rustic crag]

i forget this is all open source lol

[trim shell]

It's even more work, but is it also worth having some kind of style guide so that contributions aren't in many different writing styles and layouts?
I think at this stage even formulating such an idea is probably a lot of work, but maybe it's a thought?

(great work on the contributing how-to!)

[olive cliff]

a style guide definitely seems worth while

[lusty marsh]

Yeah that would be good to have, I'm not exactly sure what thee guidelines would be just yet though.
I imagine you're talking about things like using a consistent tense (past, present, or future), a way of referring to the reader (either "you'll need to" or "we'll need to" probably), etc

If anyone has ideas on other things we'd put into it that'd be good, tbh those are the only two things I can think of immediately

[trim shell]

Another thing I was thinking of might be something along the lines of tables / headers / page linkage / listings (there are so many cases that writing a guide off the bat is basically impossible, but it might be something to slowly build up as people contribute and realisations of what needs to be unified are made)

Inline figures vs. side figures and such

The thing that really sticks in my mind is "step-by-step" stuff where each step is accompanied by an image: there's many ways people could arrange those on a page

...but it's probably only worth thinking about when there's a sufficient amount of content for it to cause problems

[rustic crag]

any 3DS max users wanna help me test part of a guide?

i did something before, and it worked wonders

now when i'm writing it out and testing it, it doesn't work anymore

[orchid orbit]

inline would probably be the easiest, then there's figuring out where images should be (before or after the text?)

not to bring back memories of English class but depending how serious this is, could be worth just picking a specific writing style for the sake of making consistency easier

[trim shell]

To expand on that I think just having a few things like "tables should be formatted with <this header style> etc.", "code should be placed in a listing with/without line numbers", might be handy

I think it's good not to front-load formalism in case it blocks making progress on content (it's already been stated that this is a project that is hoped not to be abandoned!) so I guess just if there's some super obvious style things to chuck down as a starting point it might be handy, and not to dive off into a big time- and effort-consuming comprehensive style guide off the bat

[orchid orbit]

yeah haha good point, honestly as long as the information is there at all I think that's by far the most important thing

it can always be made more consistent later

[lusty marsh]

I'm much less concerned about the "not abandoning this" thing now btw.

Seeing the interest from people, especially in contributing, has given me much more hope. Making this post was definitely a good idea 😄

It's just that with private projects it's a lot easier to just forget about them and that's what I was used to when it came to documentation.

Anyway, I think having a style guide early on is a good idea (even if it's not "complete").
I'd rather have everything mostly right from the get go than have to change heaps of stuff later on because nothing was consistent

[trim shell]

At least something to start off with might be nice to prevent contributions going in many directions from the start.
I've got to get the Blender plugin update done before it's worth me chucking in a contribution on how to use it, but if there's stuff that needs to be done on that end when I'm at that point I'd help with it

(the v0.1 docs are quite comprehensive imo for the currently-released version but I think it'd be nice to not write the contribution twice!)

[orchid orbit]

yes, it was a good idea to make this post :)
I'm sure a lot of people have thought about this being a thing, glad it's finally happening though

could you pin the link to the documentation so it's not buried?

[lusty marsh]

Live documentation site: https://animatedswine37.github.io/persona-modding-docs/
GitHub Repo: https://github.com/AnimatedSwine37/persona-modding-docs

[lusty marsh]

Later on I think we should get a custom domain for the site, maybe http://personamodding.com which I'm pretty sure Mudkip owns (and uses for very useful purposes)

I'd leave that until there's enough stuff for it to actually be useful to users though

[orchid orbit]

are you thinking like, have a section for users and for modders?

[lusty marsh]

Maybe, I did want to add in some information on just setting up mods later on (for now I've settled with links to the gb guides)

Although my first focus is on guides for making mods given ones for setting them up already exist and are in a decent state

Another thing I did want to do, although I'm not sure exactly how it'd work (probably some Javascript stuff) is have some way to choose which game you're modding.
Probably at the top navbar sort of like how some sites would let you change language or currency, instead you'd choose a game and then only see guides relevant to that game

Again though, that'd be to look into once there's enough stuff that just seeing everything becomes messy

[rustic crag]

are we allowed to add new sections onto the base ones?

i was gonna write a guide on porting anything to Vita but i’m not sure where it’d go

[lusty marsh]

Yeah, go for it. Those are just some that I thought of, I'm sure there could be other things

I'm not really sure where that'd fit either, you could just make it its own section for now and we can move it later if we need to.

[rustic crag]

as long as there’s other stuff to go with it too, like a guide for porting 32 bit mods to 64 bit or something

[orchid orbit]

thoughts on having a required software list at the top of each page? helps keeps things organized and lets modders know that they need to download all these things beforehand if they want to perform a given task

like music editing for example, you'd probably want atomencd, foobar, and audacity

also would help kinda compartmentalize things so that in theory, someone who's learning has a lower chance of being overwhelmed

[lusty marsh]

I have mixed feelings about a list of required software before anything.
On the one hand I don't really like having to just download a bunch of stuff without knowing why, in that regard just having a link when you need it is nice.
On the other hand I do see how it'd be useful, like if you have really slow internet and want to just collect everything you need to download and come back later, or in case you missed some program, with a central list it'd be easier to find it.

It's probably better having a list like that than not, which do other people think is better?

[orchid orbit]

yup, that first point is totally fair. I think what could be done too as a compromise is that the guide is written to have links to the relevant software within said guide (when you need it), but also has the required list up on top. some people may prefer downloading everything first, some may prefer to take it step by step. having both means that you can serve both types of people

I would fully expect a new time modder to forget at least one application. I sure have haha

[lusty marsh]

Yeah, that sounds like a good way to go about it, maybe the list could also be collapsible so if you want you can just ignore it

[orchid orbit]

that sounds perfect

[broken kindle]

so uh. any idea why this keeps happening?

[rustic crag]

you need to run bundle install inside of the repo for it to work before hand

not just anywhere

[broken kindle]

thought i did

pause to google
oh thats what "open terminal in folder" means

[wispy sphinx]

[broken kindle]

uhh that didnt do it

in fact i feel like i didnt do anything appreciably different in the first place

[rustic crag]

what error are you getting now

[broken kindle]

same one

[rustic crag]

did you reopen the command prompt after installing ruby

just so the changes applied

[lusty marsh]

I don't think that'd make a difference

When you ran bundle install are you sure it actually installed them? No errors from it?

[broken kindle]

i got an error the first time i ran it but then i ran gem install bundler jekyll again and never had an error after

cant remember what the error was and i already closed command prompt, so. oops

[lusty marsh]

Idk then, running bundle install whilst in the repo's folder should install everything. If you say there were no errors then idk what's going on

[rustic crag]

are we allowed to add code to the css of the site?

something like easy centering of images?

[rustic crag]

debating on if i should really have image centering

maybe my brain is too used to the old style

maybe centering some of the text might help

[broken kindle]

downloading a lower ruby version fixed the problem i was having

[rustic crag]

oh i was having that issue this morning too

installing 3.0 fixed it

[broken kindle]

this kinda clued me in https://rubygems.org/gems/ffi/versions/1.15.5-x64-mingw-ucrt

[lusty marsh]

Oh, I didn't realise that. I somehow ended up with ruby 3.1.3, I'll add a note to install 3.1

[lusty marsh]

Do whatever you want

Also, I think centered images are better although it does look a bit weird to me too

[rustic crag]

i think if i center some of the text it may help

i just gotta figure out how to do that that’s not html

since we’re supposed to keep that to a minimum

[lusty marsh]

You can use html if you want, if you just want to see how it looks and using html is quicker then just do that temporarily

[rustic crag]

DX2 guide mostly done

i think the non centered pictures are definitely better now

also i redid the header on all of them to include creator information as well as base information

[lusty marsh]

Oh, that's a good idea having some reference to the writer

[rustic crag]

yeah i definitely thought it needed that

plus it adds some space between the heading and table of contents, makes it look less weird

i'm gonna wait until i have all 3 main guides done before i make another commit

and i added links to other guides as a jumping point because i did recommend that lol

[rustic crag]

lol remember when i said 3 main guides

it's gonna be a while lol

[orchid orbit]

alright well I'm finally home so I just get to learn how this all works then I'll start throwing what I know in!

[orchid orbit]

worth using examples for the guide or keep it general?

[rustic crag]

i think examples are good

for my model porting guides i pick a model at random to do and then walk through every step

[orchid orbit]

alright cool

[rustic crag]

if you want, you can check my github repo for some framework

i have a lot of pages already done

[orchid orbit]

currently editing the music section bc I wanted to split it into multiple sections. I'm not sure how much detail to go into though... like I remember showing you how I did music loops for some harder to loop songs, and I'm not sure if that's info worth having here or not really

[orchid orbit]

can you send a link to it?

[rustic crag]

yeha sure lemme just push my recent changes

https://github.com/BonQerss/persona-modding-docs/tree/main

markdown formatting is pretty easy to understand once you get the hang of it

if you know about the fancy stuff you can do in discord, half of it carries over lol

[orchid orbit]

yeah this formatting is definitely a bit unfamiliar to me lol bc I'm used to latex but I'm figuring it out

[rustic crag]

since discord uses markdown for messages

if you need to nest a page in a nested page, make sure you set the grand_parent value as the first page

that stumped me for literal hours

until one guy figured it out in two seconds lol

[orchid orbit]

gotcha lol
ok this is gonna be a really dumb question bc i'm not familiar with git stuff in the slightest but is there a way i can quickly preview the page without downloading everything

[rustic crag]

vs code has a preview for markdown files

i recommend using github desktop combined with visual studio code

it's not like, amazing

the way you have to embed images means they won't preview

it gets most of it

this screen is a better example, my bad

i'm sure there are some vscode extensions that i don't know about lol

that probably enable better previewing

[orchid orbit]

I'm not even using vs code rn bc I didnt have it and I was lazy lmao, I'm just editing with np++ and then refreshing to see the changes
...but maybe I should go actually download it again haha

[rustic crag]

yeah vs code is a god send definitely

plus you can take a screenshot with snipping tool, paste it in

and it'll embed in the preview

so you're actually able to check how images look temporarily

but you'll need to change the pathing and embedding later on before publishing

[orchid orbit]

for the music section I was thinking of doing something like this, maybe even switching it to a general audio guide

[rustic crag]

yeah i think that should work

though, i will say

you'll probably need to add a tab above that pointing to it being for P4G

like i did for my model ports

[orchid orbit]

the top 3 should be possible for all games. the bottom 2 would be possible for P4G64 and P4G32, idk about the others lol

[rustic crag]

oh right lol

[orchid orbit]

I don't even know if it's worth documenting P4G32 anymore though

[rustic crag]

i'm documenting vita stuff soooooooo

anything helps lmao

[orchid orbit]

hard carrying the vita community lol

[rustic crag]

the one and only

[orchid orbit]

eventually the bottom 2 should be possible for P3P PC and P5R PC, but probably never possible for hardware

[rustic crag]

i'm hoping these porting guides get more people porting stuff

[orchid orbit]

haha maybe, but tbh most people will just play Persona on PC Steam instead

[rustic crag]

it's potentially possible for vita

like potentially

[orchid orbit]

it's good to have the content out there though

[rustic crag]

BGME might actually work for vita in the near future

[orchid orbit]

oh, cool

[rustic crag]

i just gotta figure out how to turn the x86 code into ARM

because i know where the patch applies itself to in memory (for the vita)

[rustic crag]

most definitely yeah

if you have any more questions lemme know

[orchid orbit]

is it possible to provide files for download directly hosted on the site? 🤔

[rustic crag]

yeah dude i struggled with that today actually

it goes like this

[Here]({{ site.baseurl }}/assets/images/porting/p4gpc-vita/font-conversion/FONT TEST.7z)

[orchid orbit]

that would be great for providing a tutorial file

that's disgusting LMAO

[rustic crag]

it is lmao

lemme break it down

the [here] is the text people will click to download it

[orchid orbit]

honestly the only thing that confuses me is the site.baseurl thing

[rustic crag]

the baseurl denotes that the path starts at the root of the directory

and not anywhere else

[orchid orbit]

oh so that one never changes

[rustic crag]

yeah nope

and make sure it's baseurl

[orchid orbit]

ok that's not too bad then

[rustic crag]

some sites put site.url

which won't work

and then the path is just the path

[orchid orbit]

were you the one who did the music tutorial or was that someone else?

[rustic crag]

nah that was someone else

the only guide i have up on there rn is the SMT V one

[orchid orbit]

whoever did it I feel like I'm kinda gutting it but it's because I'm expanding on it 😭

[rustic crag]

that was oceanstuck

we really oughta add headers to our tutorials denoting who wrote them

that's what i'm adding to all of mine

[orchid orbit]

haha yeah, this whole thing is a bit of a mess right now but it's great that we've gotten started and I'm sure we'll be able to figure out a good process with time

[rustic crag]

mhm

feel free to copy and paste some stuff from my guides if you don't wanna type the stuff out

make sure you use the formatting i used for the table chart at the top, it's prettier that way

[orchid orbit]

haha thanks, I'm definitely copy+pasting a lot of stuff as I learn the syntax

[rustic crag]

oh and one other tip

if you need to share something from a site, check if they have an embed option to share it with

that'll give you HTML code to paste directly into the markdown file

YouTube has it, i know that

that's how i got the youtube video embeds

[orchid orbit]

gotcha gotcha

[broken kindle]

thatd be me lol, and honestly i just sorta cobbled together information from existing resources + other ppls mods so i guess thats understandable

[orchid orbit]

gotcha, yeah no it's a really useful start though bc I was thinking to myself about how I would structure it, but having a starting point makes that so much easier

[broken kindle]

i only rly mess with p5r too so i was kinda like, expecting that id leave out something really obvious and important for p4g or p3p lolol

[orchid orbit]

oh this is perfect - I have P3P and P4G but not P5R on PC lol

so I have this rn but it's like... where are the P5R audio files located lol

[broken kindle]

sound_e.cpk for english voices and sound_j.cpk for japanese
the rest is in base.cpk/sound

[orchid orbit]

ty!

[broken kindle]

also p5r audio is adx not hca lol

[orchid orbit]

oh good catch that was totally copy pasted lol, ty

[lusty marsh]

Not worth documenting p4g 32-bit stuff at all imo, with vita it makes sense because it's a completely different platform but 64 bit is just the superior version on pc.
The only reason anyone would still play 32-bit is for mods that aren't ported but that'll all be done eventually at which point there's no reason to play it (other than piracy ig but I'm not making guides that only pirates will use).

[lusty marsh]

Use %link and it'll be nicer...
[A thing]({%link /assets/some file.zip %})

[rustic crag]

lol i always forget about link

i've been copy pasting shit from fail overflow and it just slips by

oh man i just realized

i've been using baseurl for all my images the last few guides 😭

[lusty marsh]

It's fine, either way should work, link's just a bit nicer since if the link's invalid the site won't even build instead of stuff just being missing

[orchid orbit]

is this correct or is this misinformation

[rustic crag]

i will say uh

if you're unsure about something

all the code is open source

so anyone can go back and change it later if they want to

[orchid orbit]

kinda makes me wonder what's going to happen with some of the old P4G mods like if the mod authors arent active anymore

[lusty marsh]

It looks right although I'm not sure, I've never made a music mod. I'd have a look at an existing one to see if that's how they do it

[orchid orbit]

true but I don't have P5R on PC so it's gonna be a pretty consistent issue 😆 this is a quick question anyways

if the BGM is stored in an archive called BGM.awb then that should work in theory

[lusty marsh]

https://sewer56.dev/p5rpc.modloader/usage/#replacing-music

It says it works the same way as p4g64 so if that's how it does it I think it'd be right

[lusty marsh]

If they really are inactive I'm pretty sure per the default license + GameBanana rules people could just port and publish them.

[broken kindle]

yeah u gud

[orchid orbit]

oh sick

[orchid orbit]

awesome ty ty. yeah gonna need any P5R modders to verify anything I write for it haha

[rustic crag]

yeah that’s how it goes with vita ports

if the publisher doesn’t respond within some time i just publish it

and then mention that it can be taken down at the owners discretion if they ask

[rustic crag]

dunno if we're allowed to have the entire guide be under a tab but that's what i did for models >.>

there's gonna be 3 or so guides for that one and i didn't want the page to be super long

[lusty marsh]

If it works I guess it's fine

Although if it is an entire guide like what you scrolled through a separate page is probably better

Because if you reload the page it'll always go back to the first one and I don't think you could link to headings in other tabs

[rustic crag]

oh that's a fantastic point

[broken kindle]

so are we just going to let this scope creep into being about persona modding in general instead of just pc persona modding

because if so i have 5 guides to write about q2 without permission

[lusty marsh]

Yeah that's fine

[rustic crag]

was it ever PC exclusive?

[lusty marsh]

It's just I personally only know about PC modding so that's where I was starting. If other people want to do other games go for it

[broken kindle]

i just sorta assumed it was since before i touched it the getting started pages only rly talked about reloaded lolol

[lusty marsh]

Yeah, if we are going to expand out more I'm going to have to work out something to let you pick a game. So in the navbar or something you'd click P4G Vita or P5R PC and only see stuff relevant to that

Eitheer that or we just stick everything for each game under a section but I don't think that'd be ideal since a fair bit of stuff goes accross multiple games

[rustic crag]

i think the tab at the top would help

i've seen sites that can redo everything based on the platform selected

[broken kindle]

yeah like i wrote the music guide assuming you (general you) were modding pc and thus wouldnt need to repack awbs all that often, but from what i can tell repacking awbs is...the default for console mods because aemulus doesnt have awb merging

[rustic crag]

oh well if need be i can write a guide on that for general use

i technically already have as part of my music porting guide

that applies to P5R switch, PQ2, and P4G vita yeah?

[broken kindle]

the first two definitely, the last one i wouldnt know but you would

i do explain how to repack an awb its just that the first sentence is like
"lol you wont need this that often but heres how to do it in case you do"

which i wouldnt have said if i hadnt assumed this was a pc guide

[rustic crag]

yeah i just read it

that's the gist of it lol

i think if anything

i should probably just add how to make AT9 files to the documentation

but isn't brawler completely rewriting the music guide anyways?

[broken kindle]

yee lol

[rustic crag]

yeah it'd be best to wait then

i will say though

a few of the importing guides i'm making aren't just for vita

they work on PC and i've had people test the models

the only vita exclusive section is just the porting section

for obvious reasons lol

[orchid orbit]

yeah i noticed there was like nothing on PC specific stuff so I was adding to that (slowly) haha

I think knowing how to repack the awbs is still pretty useful, although what I will say is that I have never successfully gotten sonic audio tools to work

it always gave me a bad magic number error or something

[broken kindle]

i think i got my version from a q2 guide?? idr but it worked when i was using it for the q2 black mask mod which is the only thing ive repacked an awb for

[rustic crag]

oh speaking of packing an awb

technically you don't have to do it for Q2 or Vita

https://gamebanana.com/tools/10283

someone made an aemulus package for merging awb files automatically

that only supports P5R PS4 and Switch

i still gotta figure out how to update it to support Vita or Q2 but it should be possible as it's just a batch file

if we get it worked out, we can just link this instead of instructing how to repackage an awb

[orchid orbit]

yeah that would be cool bc repacking them is super finicky

[broken kindle]

prolly

though console awb merging should prolly be its own project thread lol

[rustic crag]

true lol

[lusty marsh]

That Aemulus package seems like a bad idea to me, it seems like it requires users to manually put the original bgm files in the original folder (which they will not want to do). Also, you're redistributing the entirety of Sonic Audio Tools with every mod that uses it.
If it's something people need it should really just be added to Aemulus, that's an extremely janky work around when the program's open source.

Anyway, leave that discussion for another post or something

[lusty marsh]

I'm starting to work on the filtering by games thing and the first thing I'm wondering is how we should indicate the games a page is for.
My initial thought is to go with labels like this (colours and stuff to be worked on) which I think looks alright.
The other thing I was thinking of is using the game's logos like the emotes we have ( , , , etc) but then I'm not sure how we deal with games on different platforms like p4g vita or p5r switch

[broken kindle]

the labels are probably more efficient for indicating game and platform at the same time yeah

it might get a little visually cluttered for something like an aemulus setup guide that would apply to a lot of games at once (every console release + p5s), but idk if anyone necessarily minds that

[lusty marsh]

We could probably do something special for cases like that, either some kind of dropdown to see all the tags (like a ... button) or just a label specifically for games that Aemulus support

I don't think we need to worry about that just yet though

[orchid orbit]

those labels look pretty decent.
my take is it might be worth focusing on PC mainly and specify other platforms as special cases because to be honest, the vast majority of persona modding happens on PC

[lusty marsh]

Yeah, that's what I was thinking as well. "P4G" would always be P4G PC whereas "P4G Vita" would be specified if it's for vita

[orchid orbit]

also I've noticed the guide only covers the games on steam + Q2... worth throwing some FES stuff in there since a lot of it is the same iirc? although I don't really mod FES

and then if P3RE gets modding that's gonna be a new category too haha

[lusty marsh]

Oh, those in the screenshot were just a few for example. You'd be able to set the game to whatever persona game you want to

[rustic crag]

i actually had an idea for icons

it might be a little dumb but it’s in the similar vein

same icon, but add text or an icon denoting the platform

like the P4G logo but with a vita icon behind it or the letters PC to denote between them

[broken kindle]

not bad actually

[rustic crag]

id draft something up in photoshop but i’m in bed

[orchid orbit]

yeah that's a good idea

have like a computer icon for PC

[rustic crag]

yeah yeah

there’s a stock vita icon on google that i use for some thumbnails

should be for PSP or 3DS too

[lusty marsh]

I think that'd be messy with multiple games, at least how I'm imagining it

So just the icon edited to have a platform next to it?

[rustic crag]

nah the icon with the platform behind it

like in one square picture

man do i need to get up and draft it up real quick lol

[lusty marsh]

Would it be big enough to be easily recognisable though?

[rustic crag]

i don’t know if i’m explaining myself well enough :/

[broken kindle]

i was thinking icon with the platform in the corner

[lusty marsh]

These icons are relatively small

[broken kindle]

also honestly just 2-3 letters saying "PC" "PS4" "SW" etc would probably be clearer

[orchid orbit]

I was thinking like
P5R
P4G 🖥️
etc

don't even bother with the game icons

idk

[rustic crag]

if the icons aren’t recognizable, you could always add some text that pops up when hovering over it lol

[orchid orbit]

probably need to see how it actually looks in practice

[rustic crag]

this too

[lusty marsh]

Something like this? (it's a bit funky but you get the idea)

[broken kindle]

idk, how would this look at icon size

[lusty marsh]

We could make it bigger but only I'd only go up to the size of the heading

[rustic crag]

yeah i think this looks good honestly

i will say though uh

[broken kindle]

the switch icon is invisible on that p5r label lol

[rustic crag]

what about universal stuff like my model porting guides

those aren’t PC or Vita exclusive

[lusty marsh]

Can just use Universal for that

[orchid orbit]

yeah lol, easy to fix tho - just get a black and white version

[rustic crag]

oh true lol

forgot about universal

[orchid orbit]

(also I kinda wonder if P3P should be pink (FEMC) so that P3F could be blue)

[lusty marsh]

I don't mind changing it, the colours are all temporary. It was just to get my idea accross

[orchid orbit]

gotcha gotcha

[broken kindle]

oh well if were making color suggestions, i think orange fits q2 more

purple makes me picture q1 (or p1 i suppose)

[rustic crag]

lol you think anyone is gonna write guides for P1/2

and then we gotta add more labels

[orchid orbit]

probably not worth considering P1 or P2 in general (I know I'm pulling an ATLUS here)
mainly bc their file structures and such are so different

it's a pretty niche modding community anyways anyone who's in it kinda already knows their shit or knows who to talk to

[broken kindle]

i mean that was just an aside really, although i do find it funny that aemulus supports p1 psp

[lusty marsh]

Yep, if they want to contribute they can but until then classic stuff can be left out

[orchid orbit]

I've heard it's broken rn though 😭

[broken kindle]

LOOOOOOOOOOL

im never gonna play p1 anyway

[orchid orbit]

my understanding is that the functionality was added but whoever added it didn't really understand P1 modding super well or something? idk

anyways

I think classic Persona could go in its own categories later if desired. 3-5 share enough similarities in modding that they can be documented together the way this is happening rn

swine are you still thinking about allowing users to like select their game or similar?

[lusty marsh]

Yeah

[orchid orbit]

I'm guessing there will just end up being some duped text for different games that share similar but slightly different procedures. do you have a plan for that in the short term or not worth thinking about rn?

[lusty marsh]

In cases where there are only slight differences it'd ultimately be up to whoever wrote the guide but I'd say if it's small enough that it could just be put into a tab with the different thing per game then that should be done (like if a command changed or the location of some file).
If it were much more than that then it should probably be split into different pages even if there's some duplicated text

[orchid orbit]

alright

[lusty marsh]

I've been working on the game switching thing for quite a while now and I've got something seemingly useable. I'll still need to mess with css a bit to make it not ugly but that'll be a problem for another day

[rustic crag]

id say that works pretty well

how much would the end user need to do to make sure the page is tagged appropriately?

oh and we should also definitely start formulating the style of the guides

i don't know if my emojis are gonna be allowed lol

just a leftover part of the gitbook stuff

[lusty marsh]

I assume you mean the guide's creator; it's pretty easy to do, you just add a list of games to the frontmatter of each page (I'll explain it in the docs once it's out)
So a page could look something like this:

---
title: 👿 SMT V Models
layout: page
nav_order: 1
grand_parent: Models
parent: P4G Model Porting
games: ['P3P', 'P4G', 'P5R', 'PQ2']
include_toc: true
---

... Actual content

[lusty marsh]

Yeah, we definitely should do that. With emojis like that I think we'd have to go all in one way, either every title starts with one or none do (none is probably just easier)

[rustic crag]

super simple, nice

and yeah i meant the creator, that’s my bad

[rustic crag]

i was kinda hoping we could have fancier icons in the header but i’m not sure that’s possible

seems like it only supports unicode characters

[lusty marsh]

Wdym by fancier icons?

[rustic crag]

unless i managed to make a super tiny 64x64 image and applied it there

[rustic crag]

like an image denoting what the guide is for, but in the size of an emote

originally when i had assets on gitbook, it had support for it

and i was using images from steam grid db

[lusty marsh]

Unicode characters would definitely be easier but images should be possible, it might just be a bit of a pain to set up initially

Do you have an example of how that'd look from your gitbook one?

[rustic crag]

i might be able to pull it up later

but images were pulled from here https://www.steamgriddb.com/game/37347/icons

if it’s too much work i can understand avoiding it lol

[lusty marsh]

Once I've seen how it looks we can decide, if it looks really good it could be worth the work

[rustic crag]

ah i misremembered, it was only an icon for the actual websites page, not per document

my bad

[lusty marsh]

All good

We should add a favicon at some point but I'm really not worried about that while actual content's still being sorted out

[lusty marsh]

I think it's looking alright now. I'll push this to the live site in a bit once I've added the contributing documentation.
For now I've removed that platform icon, we'll work out exactly how we do that later

[rustic crag]

looking fantastic

i may look into adding some stuff to the index pages

like universal tools that are helpful to have maybe

like image magick or notepad++

index pages are looking pretty barebones at the moment

[lusty marsh]

Yeah they were just placeholders

The game filtering stuff's live now btw

Oh, also titles are now automatically added to the top of pages and you can add a table of contents easier by just adding include_toc: true to the front matter (check contributing docs if that's unclear)

[rustic crag]

hmm

do we have to have the "include_toc" part?

i kinda prefer to have the table of contents be after my blurb about who wrote it

[lusty marsh]

That's fine, it's just an option

[rustic crag]

cool cool, just double checking

[lusty marsh]

Ideally I'd add something like the games thing where you put an author name in the front matter and it automatically fills it in.
I just haven't done that yet

So there'd be some file where you write out a blurb or something and it'd just pull from that whenever you're listed as an author

[rustic crag]

oh yeah that'd be handy

the vita game tag is just P4G Vita right? i don't see it mentioned in the contributing document

[lusty marsh]

Yeah, it's P4G Vita

I should add a list of all of them

[rustic crag]

yeah that looks a helluva lot better now lol

loving the tag system so far

good changes all around, thanks

you can have pages tagged under multiple games right?

i can't seem to get that worked out

[lusty marsh]

Yeah

Something like games: ['P3P', 'P4G', 'P5R']

[rustic crag]

games: ['P4G','P4G Vita']

this seems correct

oh with a space

[lusty marsh]

That does seem right...

[rustic crag]

weird

it's a little weird on my end

it didn't show up unless i clicked the option under table of contents

[lusty marsh]

Wdym?

[rustic crag]

like before hand, it was just this

but then i clicked the mention of the pages of it here

and then it loaded

[lusty marsh]

What did you have your game set to?

[rustic crag]

p4g vita

it's working now

[lusty marsh]

I'm not sure I understand what's happening. If you go to a page and you don't have the game set to one on it it'll change the game, I think that's it? (Like if you were on P4G and went to a P5R page your selected game would change to P5R)

[rustic crag]

yeah i think that's what happened probably sorry lol

it does seem to change to the first tag listed then the second

so maybe something acted funny for a second

got all the pages updated

[lusty marsh]

nice

[lusty marsh]

I've changed the games so they're now pulled from _config.yml so it's easy to add new ones. There's info on that (and a list of all the current ones) in the docs
https://animatedswine37.github.io/persona-modding-docs/contributing/#adding-a-game

[orchid orbit]

i havent rly looked at this too much but im back to it now and well obviously there have been some changes to the site since i initially forked it. this is definitely my inexperience with git but is there a way i can update to that latest version?

[rustic crag]

go to your github page and click sync fork

and then in github desktop click fetch origin and pull origin

it’ll merge the changes

[orchid orbit]

ty

[orchid orbit]

are dropdowns supported? I want to have a list of IDs since it's not documented anywhere else but I'd rather have that be a dropdown

[orchid orbit]

just made a pull request for music/audio (I figured it would be good to switch it to focusing generally on audio)
there's some more stuff I want to add later on as well as potentially fixing up the structure but figured it would be good to get some eyes on it first

[lusty marsh]

Thanks for making that. It's clear that there's still a bit to add but it looks like a good start

[lusty marsh]

Wdym by dropdowns? Like a list that you can collapse?

[rustic crag]

probably

but aren't dropdowns just html code

[lusty marsh]

Yeah, if you can do it with html then you can do it. I don't think there's any way to do it with markdown (at least nothing I've set up yet) unless I'm just misunderstanding what you mean

[rustic crag]

i think they mean a standard way of introducing what you had for the tag choosing system at the top of every page

like how you can add tabs

some variable stuff pointing to this and that, and it adds a dropdown option into the page

like tabs, or how you can insert special things like tables

[orchid orbit]

yeah

[orchid orbit]

unfortunately most of my knowledge is p4g related 😆
I think a lot of the stuff from p4g applies to p3f too, and I think I can figure out p3p too but it's not something I know a ton about

and then i dont own p5r lol

[orchid orbit]

although i might just throw this on the amicitia wiki instead actually

[lusty marsh]

If it is a table of IDs then yeah, putting it on Amicitia and linking to it would be better

This isn't meant to replace the wiki, they should work together if that makes sense

[orchid orbit]

sounds good

im also hesitant to like add a ton of documentation related to bgme since well it's actively in development haha but

[orchid orbit]

made a pull request to add some more audio stuff! fortunately P3F and P4G are very similar with their event file formats
honestly i feel like some of those pages are a mess with the information there, so if anyone could look over them and either just make them more readable or let me know what I could change about it, that'd be awesome

[broken kindle]

i forgot to mention that you need the vgmstream plugin to listen with foobar, oops

[orchid orbit]

clearly we both forgot that lol

[orchid orbit]

made another pull request! added a publishing guide and did some more audio editing stuff

I can definitely add some more stuff, although (1. i'm going to eventually run into the limits of my knowledge, and (2. it may require some restructuring of the guides rn

[lusty marsh]

Nice, thanks for the contributions

What about the guides do you think would need restructuring?

[orchid orbit]

I was thinking about contributing some stuff specifically based on what I've learned for events. as I've gone through that, it's made me wonder if perhaps events should be its own category. while it is just audio and text editing I know at the end of the day, I still feel like spreading that info out between the existing audio and text sections isn't the best

[rustic crag]

maybe it can go under flowscript

considering swine was going to write a guide on flowscript

[orchid orbit]

it's not exactly flowscript though. well, some of it is flowscript related, but even if you ignore that, you can still mess a lot with BGM/SFX calls, message calls, text edits, bustup/voice line calls, etc etc...

[lusty marsh]

Having it under an events section should be fine

There's definitely some overlap between topics.
I think you could have detailed information about specific topics (like flowscript or text) in their own sections and then have just what you need in other places (like in this events section you may briefly go over flowscript or text stuff) and reference those detailed sections for more information.

[smoky locust]

Would it be alright if I contribute via Video? Because writing in google or here can take a while and I just have an idea to just record display and share it here.

since i have like over 40 tutorials already

[solid raptor]

oh this exists

i talked about this recently ish?

[smoky locust]

I would be able to write the tutorial for you. Got free time though but whether it's detailed or not and to your expectation maybe you might want to see the tutorial i created first. If that's to your liking, then cool

Although wouldn't teaching someone be twice as much tired as compared to making it yourself especially if that someone has never done that tutorial or what you do? Cmiiw 🤔

[lusty marsh]

Do it however you want to, as long as the knowledge is being shared I'm happy. Ideally everything would have text versions but I understand that could be hard for some things so I don't have a problem with just having links to youtube videos on some pages

[smoky locust]

[rustic crag]

sorry to necro this thread but

computer is finally up and running

found my completely finished guides that i forgot to commit to github

hella stuff

expect a commit with it all soon

[lusty marsh]

Nice

[lusty marsh]

Hello everyone, it's been a while 😄
A week or two ago someone brought up documentation stuff in #p3-modding-chat and after some discussion I decided to try and find an easier way for people to contribute to the docs site. I ended up finding Decap CMS which is an open source content management system that lets you edit the docs in a browser without needing to interact with Github at all (other than signing in with your github account).
It's taken a while but I've gotten it deployed to the public site in a state that is usable (but far from complete). If anyone wants to test it out you can go to https://animatedswine37.github.io/persona-modding-docs/admin/ and sign in with GitHub, the rest should be relatively self explanatory.

As it is I'm pretty sure someone could write a whole guide in it although there are quite a few problems. Some might be me misconfiguring Decap but some might just be problems with it. They are:

• Nested folders don't work correctly, it seems to pick up the wrong pages and not group them (you could look at the Porting section for an example). This is listed as a beta feature of Decap so it might be something in that
• You can't add a new section (like "Getting Started" or "Audio") yourself, you'd have to ask me to. I don't think anything can be done about this
• The preview display is very minimal; jekyll specific stuff like tabs and callouts won't show and in general there is no styling unlike the actual site. Decap does let you register a custom preview window so in theory I could completely recreate the actual look of the site although that sounds difficult.
  • I do want to at least do some of this, in particular I'd want to get tabs and callouts displaying.
  • Along with that I'd also like to a way to add these in the rich text editing view so you don't have to write out stuff in raw text.
• Not specifc to Decap but in general the site needs some work with layout and things

Sorry for necroing this post but it feels like the most appropriate place. If you no longer care you can always unfollow it as hopefully there will be some more activity in here

This is what the web ui looks like

[merry leaf]

Just curious; is it actually necessary for the login to gain all of these permissions? like maybe im just misunderstanding this but i feel like the site shouldn't need full read/write access to my account's personal data just to let me try and make edits 😅

(not that im saying you would do anything actively malicious with it, just very concerning to see that it apparently wants access to all of this just so i can login to the thing...)

[lusty marsh]

huh I didn't see that when I logged in

It shouldn't all be necessary, the only thing it should really need is read write access to your fork of the documentation's repo

I'll see if that's something I can change. I don't think it will actually do anything with most of that either way though

[lusty marsh]

Apparently I'd need to use a github app instead of oauth to have much more granular permissions (like only access to a single repo). I think I should be able to scope it back to just public all public repos for now though. I'm not sure what the personal user data is for but I think I can change it to just read access if it is actually necessary

There we go, it should be right now

[merry leaf]

Yep, shows that for me too 👍

[lusty marsh]

Turns out repo and user were just defaults I forgot to change, I think it should work with just that

Ideally I would switch it to an app so you could authorise just to the modding docs repo but that sounds like it probably isn't easy. This should be fine for now, people can just trust me lol

[merry leaf]

A lot easier to trust you when you're not asking for permission for everything especially 😅 lmao

[lusty marsh]

yeah lol

Well if any of you give a serious attempt at using it please lmk how it goes. I've not used it much myself, I've basically just set it up and checked that it seems to function

[orchid orbit]

I'll take a look tomorrow

[ocean prism]

[crisp dust]

Just gave it a try. Seems to work fine. Getting to this point was seamless at least

[lusty marsh]

Oh I didn't even think about mobile. That's cool that it works on it

Hopefully it's actually usable. Presumably you won't be able to see the preview as well though

[crisp dust]

I definitely wouldn't write docs on mobile lol. Just wanted to see if I could do the setup quick and I can

[lusty marsh]

I hope you don't write any guides on it lol

Ah fair

[broken kindle]

i mean ill take having one less repo eating space on my laptop lol
the fact that i should probably get a new laptop anyway aside

[lusty marsh]

Well it still could be useful if you need to make minor fixes or something like that ig

[broken kindle]

god i havent looked at these things in ages, i should add to it again if i spot something i could add

[lusty marsh]

That would be cool, any extra documentation is always good imo

[crisp dust]

I plan to update the "using mods" section for all games. I think I could improve on what's on gb atm

[lusty marsh]

Nice

All of the section names could probably use work. It's a bit confusing how there's using mods and getting started, it should be clearer that one's for making. Same thing with the porting mods section, that should probably just go under the type of mod (like models or whatever)

In general what is on the site currently is very wip

[ocean prism]

I click the save button.
But it still says unsaved changes......

Halp

[lusty marsh]

Does anything pop up?

[ocean prism]

Nope

[lusty marsh]

Weird, let me try

I don't even have a save button 😕

[ocean prism]

[lusty marsh]

I'm sure it was there before lol

Oh it was a cache problem, I needed to cleaer it

It worked for me...

[ocean prism]

Hmmm

[lusty marsh]

Does the button change to say Saving when you press it?

[ocean prism]

Nope. No reaction

[lusty marsh]

Strange

Can you check the console

[ocean prism]

?

[lusty marsh]

Press the console tab

[ocean prism]

[lusty marsh]

All of the warnings are sort of expected rn. I think I can fix them when I move the site over to a different domain

Those errors are probably a problem though

[ocean prism]

😅

[lusty marsh]

Do you have an adblock or anything like that enabled? Maybe it's breaking something

[ocean prism]

Hmm

It's firefox?
So maybe it has something

I'll try edge

[lusty marsh]

I was doing it on firefox on my laptop and that was fine. It's worth trying though

Has anyone else been able to try?

Maybe it works for me because I own the repo...

[ocean prism]

OH

the page was so big

I didn't see this XD

[lusty marsh]

Ohh

Um ok that's breaking stuff

I don't really understand the path thing rn, I might be able to just remove it given nested collections are broken anyway

Give me a second

[ocean prism]

[lusty marsh]

Could you try again now, the path field should be gone and hopefully it'll save

[ocean prism]

It's still there

And same problem

[lusty marsh]

Did you try refreshing?

It's not there for me anymore

[ocean prism]

Close and cleared data cache

[lusty marsh]

Which page is this for?

[ocean prism]

https://animatedswine37.github.io/persona-modding-docs/admin/#/collections/getting-started/entries/extracting-files

[lusty marsh]

Oops I must've missed that section

I have to make the change for each section individually

One sec

[ocean prism]

Rip

[lusty marsh]

Nope it is right

Try refreshing with ctrl+shift+r

It's gone for me now

[ocean prism]

I cna save!

[lusty marsh]

Nice

[ocean prism]

I have submitted a page for review

[lusty marsh]

Oh cool

I'm not actually sure how that works lol

Presumably I'll be able to see it somewhere

[ocean prism]

We're breaking new ground

[lusty marsh]

Oh it makes a pr for you
https://github.com/AnimatedSwine37/persona-modding-docs/pull/15

That's neat

[ocean prism]

Ahhhhh

Nice

[lusty marsh]

I'll have a look

Oh p3r stuff, nice

[ocean prism]

[lusty marsh]

I think I am meant to be able to see it somewhere in the web ui though, I'll have to try and work that out

[ocean prism]

It's definitly easy and user friendly to add stuff now

[lusty marsh]

I'll have a proper look at your pr sometime tomorrow (or maybe the day after) btw

[orchid orbit]

all this is good to hear. you might want someone else to help manage PRs though haha

[orchid orbit]

I do recall that the original intent of these guides was to be for mod making, not mod using

I suppose it couldn't hurt to have a small section on using mods but I think the GB tutorials are already pretty good for that and it might make the site cluttered lol

[crisp dust]

I think keeping "using mods" would be good as a driver to the site. If it gets good and we start directing people there over gb, they'll see "oh, there's loads of other stuff for making mods too. I can check that out" etc

[ocean prism]

I made this one for using mods (Before Sniwe's was updated)
https://modding.wiki/en/persona3reload/users

[orchid orbit]

does the old method of jekyll still work? this has a few limitations for formatting that jekyll does not have

other than that? it looks pretty good, I like it. one minor gripe is that the preview doesn't work perfectly but for the most part it's quite good

[lusty marsh]

Yeah you can still do it locally like before. If you've already got it set up imo that's going to be a better experience anyway

[lusty marsh]

This is very true lol. I wouldn't mind giving a few people write access to the repo to try and speed up prs being merged and things. I'd just want to be sure we all are expecting something similar for their quality and stuff.
I think I had some guidelines in the contributing section but it might be good to review and update them. I'll also need to add a new bit to contributing using the web UI as there's no link to it rn

[orchid orbit]

I don't think that will be a problem anyways (the first point). the web UI stuff, maybe just because writing sucks lol

giving a few people write access would be helpful though along with honestly making this more public, maybe posting about it in announcements

[lusty marsh]

I kinda wanted to improve the UI before getting people on board but if you think it's usable (I've still not actually made anything real on it myself) then I don't mind making an announcement

I will need to at least add to the contributing section so it links to the web ui and explains it a bit before then though. That shouldn't be particularly hard to do (and someone else could always do it for me :D)

[orchid orbit]

you can make changes to the UI?

[sweet locust]

you could make it look like anything since we can just edit the source code lol

[lusty marsh]

That and there's a function it exposes for replacing the preview window (and some other stuff). If I can avoid it I probably won't actually edit the source

[lusty marsh]

Hey all, after quite a long time of basically no one using the docs I'm trying to revive them (hard to believe it's been a year...)
The existing docs have been migrated from Jekyll to Docusaurus by @mint robin.
This gist of Docusaurus is:

• Made specifically for documentation so probably will be better to work with than Jeykll (which is really a blogging platform)
• It's built with react and uses mdx for files (markdown plus react components)
• It allows for custom react components in files so we could add fancy stuff to docs if we wanted (I'm not sure what specifically but I'm sure it'll be useful at some point)
• Still a static site so I'll still host it for free on github pages
• Still open source
• Built in support for translations (I've not looked into this at all yet but sounds good)
• Support for blogs alongside documentation (I imagine we could have a blog with information about any substantial modding developments)
• Support for search (not something I've set up yet)
• Looks pretty :)

I've not written an updated contributing guide yet but if anyone does want to start doing development on the docs locally they can.
https://github.com/AnimatedSwine37/persona-modding-docs
https://animatedswine37.github.io/persona-modding-docs/

One of the big reasons that the old docs died was seemingly the barrier to entry for actually editing them. You had to get used to github, install ruby, clone the repo, etc. I did try out a CMS that would let you work on the web but that didn't really work out.

The plan for this new site is to use TinaCMS to allow people to edit the docs in a web ui, no need to install node or anything. It's open source, looks fairly nice, and hopefully will give people a good experience. I plan to try setting it up on the weekend but we'll see how that actually goes.
The one downside is that I will actually have to host it on a server (unlike the docs themselves which are handled automatically by github pages). I don't think it should be a big deal but it is something that'll probably take some time to get going nicely.

As soon as Tina's up and running and we've got a decent contributing guide I'll make an announcement about it so hopefully more people will start contributing. The fact that I don't think the old site was really publicised anywhere definitely contributed to it not getting anywhere...

Also, I'll see about getting the site a proper domain before that point (probably personamodding.com) so it's easy for people to remember

[sweet locust]

[mint robin]

Wow this is a really big overhaul

Also we can use md files instead of mdx

[mint robin]

Do the other megaton games have a separate site for documentation?

If not maybe we can maybe add support for documenting them here

[orchid orbit]

They don't as far as I know, but I think we'd probably rather focus on topics that are already in this server. the SMT modding server is its own thing now so I think I'd rather we focus on persona stuff first (maybe metaphor too)

[mint robin]

Alr

[orchid orbit]

idk how editing permissions work here but if it requires PRs, would it be possible to get a few other people able to accept PRs just to speed that process up a bit?

[mint robin]

well this is a problem

TinaCMS doesn't seem to work that well with docusaurus

Atleast when i try to do it

Someone else might have more success than me

It does work well for documents which don't import tabs tho

[oak gate]

https://tina.io/docs/editing/markdown#overview

i think you have to register any react components you want to use in the editor beforehand

[mint robin]

alr

[mint robin]

I somehow managed to nuke literally everything…

While trying to fix the sidebar

[orchid orbit]

me when I accidentally use Megidolaon while trying to fix the sidebar

[mint robin]

Even the pages don't render anymore 💀

i think i used up all of my luck while porting the actual content because suprisingly other than image paths (btw please don't use space in image names or folder names) i didn't have any issues

Even while moving the project from typescript to javascript, no issues at all

[lusty marsh]

I've not actually tried it yet but based on the docs it seems like you can choose whether stuff can go directly to main or it makes a pr that someone merges.
I'd probably want it to be via a pr so someone has to review stuff first so someone doesn't go and nuke the site or change every link to malware sites or something. I do want to get a few people added as contributors to help with it. Astro already is and I was thinking of adding you if you want. If there are more people who are relatively active and willing I'd add them too

One it's actually up and running I'll play around with it all to find out how it works in practice then we can make some more concrete decisions

[lusty marsh]

Thinking about this again, Brawler is probably right. It'd make more sense to have the website match this server in terms of what it supports.
I do sort of also want it to be a general site for persona modding alongside the docs. The docs would be the bulk of the actual content but you could also have a pretty landing page with links to the discord server, maybe Gamebanan pages, relevant stuff like that

That said, once we get stuff working well for us I wouldn't mind going over to the SMT people and asking if they want to make something similar for themselves. A different site like smtmodding.com that is basically just a copy of our one but with their stuff. Whether they actually want that and would use it would be up to them

[mint robin]

Ya we should be able to do multiple categories ya

Like we have two categories rn by default Blog and Docs

Also finally I can message again, for some reason my mobile network and my WiFi both went down for almost 20 minutes 💀

[orchid orbit]

I was hesitating to directly ask, but since you brought it up, sure, I would be interested

[lusty marsh]

Cool, I'll add you as a contributor then

I can't see a button to do it on mobile so I'll do it tonight

[orchid orbit]

yayyy thank you

making edits a PR sort of thing sounds good to me! as long as it is as effortless as possible to just make/edit a page and then submit for approval

actually since we had modding events in the past - could make writing guides a small event lol to maybe add an incentive for helping out. that's a different discussion but y'knowwwww

[lusty marsh]

Yeah, once it's all set up something like that could be cool

[lusty marsh]

I've invited you now, Brawler

[mint robin]

Can people try out the web gui editor? https://persona-modding-docs.netlify.app/admin/#/

Tabs aren't fixed yet but i need to check if authentication is working

[mint robin]

You will need to fork the repository because no one except Brawler and AnimtedSwine have push access

So when it prompts you to fork the repo then do it

[mint robin]

Well one more good news, it does deploy a preview website when u create a PR

But i was still not able to get tabs working

[orchid orbit]

I just accepted the invite but I kinda don't want to touch things while they're still being worked on haha

[lusty marsh]

Yeah that's fair

[orchid orbit]

i tried it out. the preview certainly isn't perfect but it's nice

like this is neat

I'm not sure how the publish system works though (haven't looked into these), do you need to approve them too?

this link also goes to the github instead which is pretty funny

if you need to approve them i think that's a bit of a problem as i think anyone that has push access to the main repo should just have those perms. idk if you've looked into that though

[mint robin]

yes it needs to be approved

[mint robin]

it's a kind of trello system

where u can check out a preview first before pushing it

But people with access to main repo can publish it using that system so it isn't just the main repo owner who has access to approve stuff

[orchid orbit]

forgot to reply to this lol but how does that system work (since I should have access to it)

[lusty marsh]

Hello again all, it's been a while :)
I've been thinking about this stuff a fair bit over the past few weeks and have done a few things to try and actually get it off the ground again. To summarise, I've

• Switched framework (again) to Starlight. Frankly there isn't an amazing reason for this, it just seemed cool. It does seem a lot more flexible but idk if we really needed it.
• Made a Persona Modding organisation on github to try and move this away from it being my thing to being the community's thing
• Bought the https://personamodding.com/ domain and got my current (still extremely wip) version up on it
• Thought about and played with tina cms, decap cms, and other options a fair bit and sort of gave up on a proper cms for the time being
  • Instead I've setup a dev container so people can edit in a browser using github's code spaces which are free (up to quite a large 60 hours of use a month)

I definitely can, and probably will, elaborate on all of this stuff. I'm just kinda excited rn since I just got the website up.
There's still a fair bit to do to bring it up to parity with the old docs, for now I've only migrated a few of the pages for testing. I'm going to try and write up a good guide on contributing by the end of today (probably within an hour or two) so people can start helping though. I don't want to (and don't have the time to) do everything myself.

One of the main changes in terms of the actual documentation is that I've properly separated everything for each game. Technically I think I could've done this with docusaurus but starlight has this pretty plugin that splits it up into tabs like this which I like

This means that some documentation will end up being duplicated but I think this is fine, and potentially better than it not being. The new goal is that, given stuff is split up per game, all documentation should actually be specific to that game. For example, whilst the general process of extracting files is the same between P3P, P4G, and P5R each will have slightly different docs. The P3P page will have examples actually using P3P's file names, etc. Same for P4G and P5R. It's more work, but worth it in the long run imo.

[lusty marsh]

I always forget how long writing documentation takes. I've gotten just about enough that I think someone could follow it and try contributing if they wanted to. I still need to add a bit to this page (the big TODOs at the bottom) but if anyone does decide to try it out let me know how it goes.
I'm particularly interested to know how it is for someone who doesn't really know any programming stuff. I think that it should be fairly easy with codespaces basically being a one button thing to set up but it's hard to say given I already know how this all works.
https://personamodding.com/general/contributing/

[open spire]

Is the localhost supposed to look like this after I run npm run dev?

[lusty marsh]

Yeah, I haven't made a home page yet lol

That's just the default one

[open spire]

Okay cool, just making sure I didn't mess anything up.

[lusty marsh]

Click on example guide and it'll take you to what's actually there (still very little, p3p is the most filled out rn)

[open spire]

Ah, ok. Thank you

[lusty marsh]

The home page should probably be a priority. I'll try and change it to something at least vaguely decent some time this week if no one else beats me to it

I just wanted to get something out now so I don't end up sitting on it for ages

[open spire]

If you write down how (because I think you said it requires an extra step). Then I could take a look at it?

[lusty marsh]

For the home page you'd edit the index.mdx at src/content/docs. There's nothing too special there other than the hero part of the frontmatter that gives the big Welcome to Starlight thing at the top. There's info on that in the starlight docs, if we do want to use it https://starlight.astro.build/reference/frontmatter/#hero

Actually I don't think there is anything special about adding a new game. Now that I look at it again I think it should just be copying on of the existing bits in the starlightSidebarTopics conifg in astro.config.mjs (I mentioned this in the adding a new page part of the current contributing docs)

[open spire]

Awesome, almost done with a test pr (because I needed to learn how) so I'll do that once I finish. Any particular things you'd want put on it or anything? Just so I can keep it nice and tidy.

[lusty marsh]

I was thinking links to each of the game's documentation pages, probably using the game's logos. So you'd open up the main page then click on the game you want to see the docs for.
Other than that we probably don't need much on the main page, at least for now. If there's useful stuff you can think of feel free to add it

[open spire]

Alright cool. Thank you for making this new documentation page. Always wanted to document stuff but didn't really have the time. But coincidentally I do now so it's perfect.

[lusty marsh]

Cool, I'm glad people are interested. Lack of documentation's one of the biggest problems with modding imo, hopefully this can make a real dent given some time.

I'm going to bed pretty soon so I'll have a look at stuff tomorrow, if there's stuff to look at. Hopefully it all goes well

[open spire]

Alright, have a nice night.

[orchid orbit]

dude... fuck yes

I'll definitely be looking into porting other pages over when I get the chance. do I still have write permissions to the main repo?

[open spire]

Is there a way to add images to buttons/cards? I've been trying to look at the starlight documentation but I can't really find anything on it.

[oak gate]

can just use html no?

[open spire]

I'm a bit new to web development. I kinda wanted to get into it because I've been meaning to for a while now. I'll look into that now, thanks

[oak gate]

actually no, mdx just supports jsx not html itself...

[open spire]

damn

[oak gate]

you can maybe try wrapping the image md within the card (where Intersting content... is)

[open spire]

Not sure if it works. Though I'm probably just doing it wrong. I think i'll take a look at some other sites built with starlight to see if anyone else has done it.

Seems like it'd have to be a custom icon. Though I'm not really sure how to actually do that (the documentation doesn't really explain much of actually making new ones).

[oak gate]

<Card title="Example">![7-Zip Download](./images/7zip-download.png)</Card>

[open spire]

I see, wasn't thorough enough. Atleast we don't have to do custom icons.

were so back

Also I just followed the example image in the starlight template. So I got all of the logos in webps.

[oak gate]

wdym?

[oak gate]

ah. generally though you should prefer using the highest quality source you can find, astro auto-converts to something more appropriate for web

[open spire]

Good to know. I got them from steamgriddb and then converted them. I guess i'll go back and just get them as png.

Interesting, it seems to remove the image after I change it into a linkcard

[oak gate]

linkcards dont use the slot (it doesn't use anything within the body)

[open spire]

I see

[orchid orbit]

I'm probably going to work on porting over existing content and maybe trying to restructure things to look nice

for starters I'm not a fan of it going P5 -> P3 lol

wooooo

the annoying thing is that the local site takes longer to load compared to the old one

a concern I have with splitting everything up by game and having redundant pages is that you might have updated info that only gets put on one page rather than being universal to all pages

at work we use specific systems engineering software to get around this issue lmao bc the exact same issue exists there too

I don't necessarily have a problem with having redundant pages we just need to probably make it clear that they're linked

ex: for a music page, we could have a blurb at the top like, hey this is for p5r! for p4g/p3p/p3r click on respective links

[broken kindle]

didnt the old one have pages that were tagged for multiple games. idk if this one has that too, i havent gotten the chance to properly look at it

[orchid orbit]

it did. it seems this does not?

i wish there was just a way to tag content as being shown for a specific game

like oh here's a general paragraph, this is applicable to (all games)
this paragraph is p5r only
etc

[lusty marsh]

It did but that didn't really work that well imo. The main problem is that it's impossible to (natively) have one page share multiple side bars, so you can't have the nice separation.
E.g. I go to the editing-music page and it has content for P3P and P4G. Which sidebar do you show them? You have to have two seperate links, one for the one that will have the P4G sidebar, one with the P3P one.

If I were clever there probably is a way to let you do it without actually duplicating the file. I think it'd probably be a custom thing I'd have to write though. I just haven't looked into it yet

[lusty marsh]

It's a new repo under the new Persona-Modding organisation so no, no one has write access other than me rn. I can add people as we go though

[lusty marsh]

I definitely get the concern and if someone does come up with a smarter way to do it I'm not opposed to looking at it. I've just done what seems like it'll work to me for now.

If we don't come up with some way to automate then I'd just have it be a part of the code review process. Have a checkbox that says "Does an equivalent page for a different game exist? If so has it been updated?' or something
If possible I'd like to have a proper review process. Once we're done with the initial setup no one (including me) should just commit directly to main. Do work on a fork/different branch and pr changes in.

[orchid orbit]

i agree. just don't know if there is an automated way to do it so if it's down to a review process like that, i think that's fine

[orchid orbit]

would i be able to get write permission again

[lusty marsh]

Yeah I'll see if I can do it on mobile. Presumably I can

I've sent an invite to the organisation. I'll give you write access after. I think I could directly give it but this way is probably better

[broken kindle]

me too?

[lusty marsh]

Sure

[orchid orbit]

whoaaaa

[lusty marsh]

Lol, probably don't do that. I will not accept it 😄

[orchid orbit]

i dont know what thats supposed to do for me anyways lol

[lusty marsh]

Idk, I think in a real organisation the company might pay for copilot and you'd have to be given access to it. This isn't a "real" organisation though

[lusty marsh]

You have been invited 🙂

[orchid orbit]

I'm doing some edits to the basic structure right now.
basically I think it's easiest to just keep everything on one page for using mods right now - i feel this site works a little better as documentation for mod makers, the linux documentation is optimistic, and rn i'm just linking to the GB guides

it can all be changed anyways but I think rn it's probably best to just link to the GB guides for that

[lusty marsh]

That's fair, I was really just using the P3P page to test out starlight. Nothing is set in stone

[orchid orbit]

mhm rn I wanna just get a basic framework setup and I think this is sufficient for now

(I'll do some more edits but I think in the absence of anyone else working actively on it, I'll try to set up the P4G page as a template)

is this page ever seen anywhere?

[lusty marsh]

Currently you can see it if you go directly to the P4G link (/P4G) but it doesn't show in the nav bar or anything. You can probably just remove it and the default can be one of the getting started pages

You should have write access now btw

[open spire]

just came back to this after having dinner. Looks like LinkButtons lets you have images. But it seems to display the full size.

[orchid orbit]

this is pretty funny bc most people don't follow this at all

most people just do game.name

honestly I know it is probably better to do game.type.name but I might just change this to game.name since that is the convention we have largely gone with in the community...

[open spire]

It's probably the part at the end. Since it says you don't need to. So then people just do whats easier.

[orchid orbit]

oh there's enough people who do use game.type.name actually i think...

[broken kindle]

i mostly follow it except sometimes name will be different (usually shorter and/or funnier but still descriptive)

[orchid orbit]

i think game.type.name is a better convention but game.name is easier to follow bc type can be very arbitrary

[broken kindle]

like for example p5d crossdressing is p5rpc.outfits.p5drag

[orchid orbit]

I will let this speak for itself

[open spire]

Maybe also because type isn't actually explained (atleast in that blurb). So then people might not attribute them to the GB types. And so get confused.

[orchid orbit]

specific to p4g, there are two game types - p4g64 and p4gpc

lol

all the other games tend to use like p5rpc for example, but p4g is in a unique spot given the 64bit release

[broken kindle]

me when i didnt realize type was "supposed" to correspond 1:1 with gb types

[orchid orbit]

yeah so i think this all speaks for itself lol

[broken kindle]

i just sorta put whatever feels intuitive for type lmaaao

like outfit mods are outfits, cheat mods are cheats, etc

[open spire]

I couldn't really find a solution (idk why images aren't really documented on starlight). So I just made the png smaller, I'll look into an actual solution after. Also it put them in a line like this which is annoying.

[lusty marsh]

I never thought that it did either. I interpreted it as an arbitrary category you pick

[broken kindle]

YEAH

[orchid orbit]

is that reasonable lol

[lusty marsh]

Yeah, ik I never follow it either lol. It is what sewer recommended in Reloaded's own documentation though so I figure it makes sense to mirror that

[open spire]

I'd say so

[orchid orbit]

also is there a need to specify, no special characters/spaces/etc

[broken kindle]

id say "unique and descriptive"

[merry leaf]

LGTM

[broken kindle]

probably?

[orchid orbit]

idk if that technically causes issues but i think it's good practice to avoid spaces and such

[open spire]

Maybe if you really want you could put that the types represent the categories on GB?

[merry leaf]

Spaces aren't an issue tbh and I think most people would be able to tell special characters are an issue when their OS (almost always windows lol) stops them from doing that (or reloaded-ii might just crash from it) but can't really hurt to mention it I don't think

(Though I agree not using spaces is good practice)

[lusty marsh]

Yes, note that it should be close to the mod's actual title or at least use. It's important in the rare case where a mod dependency isn't found. Good luck searching for a mod with Id balls.something. it needs to be reasonably searchable

Tbh I thought I already wrote stuff on that

[orchid orbit]

already covered :p

yea

[lusty marsh]

Oh, right

[orchid orbit]

average mudkip mod

[lusty marsh]

Modding Documentation Site

(I'll try and remember to clean up the description of this post later as well. Make it clear what the current state actually is since what's there now is completely out of date)

[open spire]

Also, make sure to pin the new github/site. Since the old one is still pinned.

[orchid orbit]

a small part of me wants to add the rick roll back in somewhere. just to acknowledge and honor the legacy of the previous site

[open spire]

awesome

[broken kindle]

yeah im not above memes and shitposts in my mods but not when it actually inconveniences the end user lol

[orchid orbit]

so... the images have like captions. but are these ever seen anywhere

you certainly dont see them when hovering your mouse over them

[broken kindle]

remember when i was testing bmd emulator and my test mods were literally just dick jokes

[lusty marsh]

It's just a general accessibility thing if I understand correctly. Pretty sure a screen reader would read that out if it was used. I think you also see it if the image fails to load

[merry leaf]

Can confirm it'll appear if the image itself can't (I just inspect elemented the image link and edited it to be broken lol)

[lusty marsh]

Doesn't really hurt to add it imo. It's probably not that useful for some of these images but I don't think it's really much effort anyway and someone might find it useful

[orchid orbit]

i love the opportunity to be biased

[orchid orbit]

sounds like it isn't too harmful to not have it either (which I feel like I would do bc I'm lazy...)

[broken kindle]

also it occurs to me that since im using rII.5 i dont have an easy way to get screencaps for normal reloaded lol

[orchid orbit]

install R2 and make it a portable install

I plan to do that for any screenshots I take too

[lusty marsh]

Yeah, please do use a regular R2 for any screenshots. It's what the average user will be using and presumably anyone who's switched to r2.5 will be able to work out the equivalent buttons themself

[orchid orbit]

is it me or is this slightly hard to read...

[lusty marsh]

That is not how it should be

[orchid orbit]

oh lol

[lusty marsh]

Should look like a file tree

The comment should just be next to the ModConfig.json

[orchid orbit]

looks like this on live too tho

[lusty marsh]

Oh, oops. I must've messed it up at some point

If you look at the starlight docs for the FileTree component you'll see how it should be

(hopefully you can find that yourself)

[orchid orbit]

yea i just found it

[broken kindle]

im a stickler for accessibility so ill probably bother to

whenever my adhd ass actually contributes

[lusty marsh]

I wonder if prettier broke it... I don't think it should even be applied to the MDX files but maybe I messed up

[orchid orbit]

your block was messed up is all

i dont know what happened for it to be messed up but i have found a way to fix it on my end

not done yet but this looks more correct

[lusty marsh]

Well that's good ig. Definitely could've just been me having a skill issue

Yeah that's how I intended it to be. I'm sure it was like that at some point

[orchid orbit]

oh wowwwww

that's so nice actually

[broken kindle]

modconfig.json as a folder

[lusty marsh]

Yeah, I like it. Starlight has a few really nice components

[orchid orbit]

oh yeah uh i slightly fuuked that one up huh

[open spire]

The different sizes are annoying me. But I've got them all set up (except for metaphor since it doesn't have it's own section yet). Now I need to figure out how to make them stack on top of eachother rather than be side to side like this.

[orchid orbit]

oh i am getting the feeling we are editing the same files lol

merge conflicts woooo yeah

can you add P3F too?

[open spire]

Oh right, I felt like I was missing one of them.

[orchid orbit]

I think that's a good baseline

yes, we could add the other games, but these are the most commonly modded ones

[open spire]

If you want you can just tell me what the new links are for them and I can change them. Since they're just spec'd to the original links swine put in.

[broken kindle]

people who mod other games can prob just add them on their own initiative i think, yeah

[orchid orbit]

I think the only real conflict would be with astro.config.mjs tbh

[open spire]

I haven't actually messed with that currently.

[merry leaf]

If you can might also be a good idea to give the buttons background colours too (like the "example guide" button), the P3 and metaphor logos are pretty hard to read with the site's dark background...

[orchid orbit]

dude... fuck yes

no merge conflicts probably

oh here's another one to consider - P3P PC vs PSP for example

[open spire]

I restarted a couple times after I learned a bit more. I've only added in the logos andf edited the front page index

[orchid orbit]

personally idgaf about anything that isn't PC but...

[broken kindle]

as long as theres a good framework for adding games/game sections, anyway

[orchid orbit]

do we care whether it's red or blue themed

i use the blue theme for r2 so

bc i'm awesome

[broken kindle]

regular vs halogen prob doesnt matter too much, its a purely cosmetic thing

compared to r2.5 having a substantially different ui

[open spire]

how is this?

[orchid orbit]

I would probably just use the default blue P3P logo

[merry leaf]

^^

[open spire]

Yeah I was kinda thinking that

[broken kindle]

tbh it kinda blends in with the p3p logo lol

[orchid orbit]

the contrast there is kinda bad

[merry leaf]

The pink version is hard to read now with that background haha, but overall for the other logos a vast improvement

[broken kindle]

maybe give the logos an outline?

[orchid orbit]

is it possible to make the backgrounds unique colors

[open spire]

I'm not sure, the documentation kinda sucks. But i'll take a look around. It should be editable.

[orchid orbit]

i guess you will have to document the documentation then

[open spire]

so true

no idea why, but the pink refused to die. It is blue now. Still trying to look at getting the color stuff working.

[orchid orbit]

I have stuff almost ready to push, I just need to grab P4G specific screenshots :')

[broken kindle]

ill prob wait a bit before i go back to updating the audio guides

apparently i was also working on a flowscript guide but forgor

[open spire]

oh wow astro has their own ai set up to take support tickets in discord for starlight

how has no one asked for changing the color of buttons? Am I just missing something?

Looks like i'll need to edit astro.config after all

[oak gate]

i think you can use the Picture component to have the usual HTML img attributes iirc

[open spire]

How would I go about adding that?

[oak gate]

or use the r2.5 guides

[open spire]

Also, I think i'm almost there for the colors

[oak gate]

look at the way you import the Card and LinkCard, just with Picture

[open spire]

I'm not really sure why I didn't connect the dots there.

Thank you though

[oak gate]

slight misinfo, webdev is fun when info is spread out depending on tech . it's a part of astro: import { Picture } from 'astro:assets';

https://docs.astro.build/en/reference/modules/astro-assets/#picture-

[open spire]

Ahhh ok

I'll fix it after I get the colors done

[orchid orbit]

where are cached images stored?

is that a web browser thing bc i had cleared my firefox cache to no avail

[open spire]

just restart the localhost process again. That worked for me with removing the pink.

[oak gate]

image wont update?

[orchid orbit]

mhm

[oak gate]

hard refresh

Ctrl + F5

[orchid orbit]

unrelated this is rly funny

red ui to blue ui randomly

[oak gate]

no one will know i pressed the real f5 twice writing that

[orchid orbit]

ty

i have to rewrite this section for p4g bc the files work slightly differently here lol

i definitely have a lot of BGME/Ryo documentation to add later lol... might end up being more up to date than the official docs :p

[open spire]

Also the cached files are in one of the files in the astro folder. I'm not sure which one though.

[oak gate]

should usually be the build folder

ime, but it really shouldnt matter since it gets cleared out often

[oak gate]

https://tenor.com/view/secrets-of-the-witch-monica-gif-11483419622642318617

[open spire]

Anyone here know css? Cause it seems like I have to use it if I want to change the color. And i've been trying to wrap my head around why this isn't working.

[oak gate]

[open spire]

So I have the custom ccs file. Currently it looks like this (left image), I don't know if it's correct I'm just following someone else's answer. And I have it set up in the astro.config file (right image). It's supposed to have variant= 'primary' make the buttons change to a different color. Am I just missing something?

I assume it's the css file not having the correct code in it. But I just want to make sure I didn't miss any steps in actually implementing it.

[oak gate]

https://starlight.astro.build/guides/css-and-tailwind/#theming

[open spire]

Yeah I looked at that and copied everything verbatim (I changed the root code only).

oh

didn't read the link correctly.

mb

[orchid orbit]

I've pushed my changes but I assume the website needs to be restarted to get the new changes?

[oak gate]

depends if the workflow runs on any push, i think it's the default tbh

yeah it should update automatically if you pushed to main

@orchid orbit you pushed a broken commit though

[orchid orbit]

weird everything looked fine on my end 😔

i'll go fix it...

I have. no idea what's up based on that error
all I know is that everything seems to work fine locally so I'm just like uhhhh

oh i figured it out

[oak gate]

oh, that's a neat plugin

yoink...

[orchid orbit]

what plugin lol

anyways i feel like this description really isn't helpful and furthermore I don't think my gh fork shows me if my build failed or not

so i think i've fixed it but i have no way of verifying i think?

[oak gate]

where the error is from: https://starlight-sidebar-topics.netlify.app/docs/getting-started/

honestly sure why it is working for you, it should be giving the same error locally

[orchid orbit]

yeah lol

[oak gate]

but that's programming for you

[orchid orbit]

i could just make another PR and see if it works LMAO

yeah idk though like everything worked fine on my end so i was like uhhhhh it's good

[lusty marsh]

Not really. Inside of a single page I think it'd be good to have it all the same colour but if it's different for different pages I don't think it really matters. I don't think it's going to confuse people or anything

[orchid orbit]

ok now i'm getting the same error locally

the only reason i wasn't was bc it was specifically for a page that normally isnt accessible...

[orchid orbit]

I think I have fixed everything. I found out that a lot of my errors were down to a combo of 404s and certain pages breaking (the p4g and p3p sites specifically, and I copied from P3P sooooo)

I have no idea if I did fix everything or not but I have no more errors and I don't have any other way to check.... so... another PR it is 😭
sorry about that you guys :') hopefully this does it

I guess it's a good thing this doesn't affect many people rn bc otherwise I would've reverted the PR very early 💀

nope 😭 same error

actually the error is slightly different in where it fails so i'm getting somewhere...!

[orchid orbit]

finally fixed everything. that sucked holy shit

if there is a better way to troubleshoot before actually making these commits that would be good to know, bc there were so many little issues I failed to catch bc nothing informed me of them until it was merged into main and the resultant gh action threw errors

check this out though :) https://personamodding.com/p4g/
I spent most of my time troubleshooting but the site ended up having some nice little improvements imo

[granite heart]

wait what the shit this concept has been around for 2 years and i didn't know about it????