Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Article suit parts: blobs #32

Draft
wants to merge 81 commits into
base: main
Choose a base branch
from

Conversation

NeetBux-Hash
Copy link

A little tutorial on blobs. I think its clear enough if people got through the previous tutorials. No indexing or any other files were touched because I lack experience

No markdown styling
Made a little tutorial for making blobs
Compare to saved txt file. Lots of lost details and clarification
This article needs replacing
"3718104824": "The Blood Money suit but with extra style."
},
"french": {
"1047194709": "Costume d'argent du sang avec goutte à goutte",

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line means "Blood money suit with IV drip" I believe


## Step 1: Locate the Suit in RPKG

1. Open **RPKG**

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would recommend GlacierKit over RPKG wherever possible

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's what I'm gonna do in my next article concerning overrides. The only reason why rpkg was used is bc of the user friendly oversight of the repo with the pictures. I'll add a second method with glacier to the article to use glacier that nicely flows into the next article. Might make it easier to stay on glacier too

sidebar_position: 3
description: Modifying an image in the menu
---
To continue on the adding parts page, you'll likely also want to modify the image in the menu to show the difference, change the suit's name and even add in your own suit's descritpion of it. I'll also mention a potential issue that arises when adding parts to your suit that dont come from a similiar chunk which will have to be addressed in the manifest. If you haven't read the documentation on manifest and other things in SMF (the little book icon on the left that shows up when you enable developer mode), I Suggest you read that and come back for bettter clarification after. I also advise to go back and forth between reading that, the tutorial pages on this site and modding yourself over time, so things start making more sense and you can practice in the meanwhile.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

similiar -> similar, Suggest -> suggest

@@ -0,0 +1,186 @@
To improve clarity and structure in the article, I’ll organize the information in a more logical flow. The goal will be to avoid overwhelming the reader with too much technical detail upfront and to guide them step-by-step, with each section focusing on one aspect of the process. Here's a revised version:

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's great ChattyG but irrelevant to this article

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This shouldn't be part of the article


---

# Part 1: Blobs

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Part 1?

Copy link
Author

@NeetBux-Hash NeetBux-Hash Oct 28, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes for the article after this one. My introduction up top was meant to prepare you for multiple articles that are somewhat tied in together.


---

# Part 2: Localisation Overrides

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Part 2?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll just remove the parts maybe. The point was to smooth the reader from the adding parts to the next articles


In this section, we'll focus on changing the **suit name and description** in the game by modifying the localisation files. You will need **GlacierKit** and a mod folder with a manifest file, but no content files are required. Everything will be handled through the manifest.

If you’re editing the manifest using **GlacierKit**, it will auto-suggest code to keep things clean and help reduce errors.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

VS Code does the same thing if you have the manifest schema line

```
4. Remember the **file name** and **file path** ("images/unlockables_override/" in this case).

> Keep RPKG open, you’ll need it in the next steps.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are proper admonition blocks you can use instead of markdown quotes, examples in basicretexture

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll take a look at them after I know what admonition is

```
- If you’re using GlacierKit, it will handle much of the code suggestions and format checks.

> **Note:** It might seem overkill to install Visual Studio Code for this tutorial, but you’ll appreciate the cleaner interface and error-checking features as you continue modding.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as before with admonition blocks


---

## Step 3: Convert the String to a Decimal Number

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hash is a more accurate term than number

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ill stick to using "strings" for now just to clearly differentiate the locr hash and the hash inside the locr that needs to be converted by calling it a "string". Itll make sense if you read the full article. I will change it later if needed

@Notexe Notexe marked this pull request as draft October 28, 2024 05:28
@NeetBux-Hash
Copy link
Author

Aologies for all the mistakes. I'm already working on an improved version and another article about localisation overrides that should wrap things more up. This pull request might have been too premature but I felt it was good enough to present it as a draft. Appreciate the feedback

@Notexe
Copy link
Member

Notexe commented Oct 28, 2024

There’s no need to apologise for anything, you are good.

Still needs a proper index of some sorts. it just shows the filename on top currently. The introduction might need some kind of cleaning or header too
@NeetBux-Hash NeetBux-Hash marked this pull request as ready for review October 28, 2024 13:13
@NeetBux-Hash
Copy link
Author

I think the blobs articles is clear now. Maybe the overuse of admonitions can be distracting but it highights the tutorial from the extra info well

@NeetBux-Hash
Copy link
Author

In commit tippy
I added tippy via npm. Now this changed some core files with react. The site is still functional (using yarn start --host on mobile as well). Just a warning bc idk if the pull request if succeeded can break something. As far as i can see, it only added a single line of code to a yarn document

@Notexe
Copy link
Member

Notexe commented Nov 3, 2024

In commit tippy

I added tippy via npm. Now this changed some core files with react. The site is still functional (using yarn start --host on mobile as well). Just a warning bc idk if the pull request if succeeded can break something. As far as i can see, it only added a single line of code to a yarn document

Would have been better adding that dependency using yarn instead. What is it needed for anyways?

@NeetBux-Hash
Copy link
Author

NeetBux-Hash commented Nov 3, 2024

In commit tippy
I added tippy via npm. Now this changed some core files with react. The site is still functional (using yarn start --host on mobile as well). Just a warning bc idk if the pull request if succeeded can break something. As far as i can see, it only added a single line of code to a yarn document

Would have been better adding that dependency using yarn instead. What is it needed for anyways?

Idk if you can view my latest articles but its just a tooltip implementation to massively shorten my guides. Idk too if you yarn start my articles before you attempted and corrected mistakes before, but trying to see or even try correcting my articles from the md files is almost impossible now. The tooltips hopes to fix both the length of the article and the code

PS im checking the commit now and it does seem to be just a single line added to a yarn or yml file but package locks changing is what got me worried

@Notexe
Copy link
Member

Notexe commented Nov 4, 2024

PS im checking the commit now and it does seem to be just a single line added to a yarn or yml file but package locks changing is what got me worried

That's because you used npm to install the dependency. This project is using yarn so you would have had to run yarn add tippy.js instead.

glossary and admonitions needs refining as well in resiurces tab
Tooltip seems to be working fine after reloading live page from yarn start. Nothing suspicious or broken going on
@Notexe
Copy link
Member

Notexe commented Nov 10, 2024

I'm confused why there is addinglocals.mdx and addinglocals copy.mdx

@@ -1 +1,3 @@
nodeLinker: node-modules

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should the node linker be changed? Currently the website seems to be using yarn PnP

description: Modifying an image in the menu

---
# Adding "Blobs"

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Quotes are not necessary, blobs are what they are called

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did that to introduce an unfamiliar term. I'll change it

4. Open it by clicking on it (obviously) and then click on *Open in editor* in the new menu that popped up on the right. This is the **repository** but in **Glacierkit**

:::tip
You now know the exact name of the **repository** file. Next time you want to open the **repository** in **GlacierKit** just type ***pro.repo***.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This tip is just restating step 3 but saying not to do part of step 3, you can just make step 3 "search pro.repo" instead of "copy this hash and then paste and hit enter but actually don't do that use pro.repo instead"

```
and its **assembly path**
```json
images/unlockables_override/47_outfits_bloodmoney_gloves.jpg

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not an assembly path, it's a blob path. The assembly path for this blob is much longer because blobs are inside the cloudstorage folder

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also this should not be a JSON code block


:::info GlacierKit vs. RPKG
While **RPKG** is helpful for viewing images in the **repository**, it’s best to work primarily in **GlacierKit**, as it will be your main modding tool. The **repository code lines** in both tools are identical for each file, so practicing in **GlacierKit** is encouraged for efficient modding.
:::

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I do think it'll be a little confusing to show two separate tools for doing something and then say "it's best to not do the first one we told you to do"


<details>
<summary>**Glossary**</summary>
### Glossary

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You don't exactly need a glossary when literally every key word possible is in bold, italic and has a tooltip

}
}
```
5. **Add Translations**: Extend the language array as needed.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is the language array

display: inline-block;
width: 12px;
height: 12px;
background-image: url('./exclam white.png'); /* Your image path */

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo in filename

@@ -24,12 +24,15 @@
"@easyops-cn/docusaurus-search-local": "^0.44.5",
"@mdx-js/react": "^3.0.0",
"@svgr/webpack": "^6.2.1",
"@tippyjs/react": "^4.2.6",

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is tippy necessary? It feels like docusaurus would have something for this

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I looked at the other articles on the site and couldn't find anything like it

"react-responsive-carousel": "^3.2.23",
"react-tooltip": "^5.28.0",

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These two dependencies appear to be useless

@NeetBux-Hash
Copy link
Author

NeetBux-Hash commented Nov 10, 2024

The copies are unfinished drafts where I want to try to change the flow of information. I'm trying to keep a balance to prevent information dumping too much technical jargon at certain points. The problem it can do is make the articles not flow as well but it's easier to follow along. Hard to revisit tho.

Also now I got some feedback, I'm nowhere near finished with either article and will probably make some "copies" for them too and just rewrite them with the new suggestions and fact checking I got

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants