openmultiplayer / web Goto Github PK

View Code? Open in Web Editor NEW

102.0 102.0 323.0 50.67 MB

The open.mp web services monorepo. Homepage, documentation, server index, and more! All in one place.

Home Page: https://open.mp/

Dockerfile 0.06% Go 14.34% TypeScript 43.25% CSS 0.94% HTML 0.08% JavaScript 0.33% MDX 41.01%

web's People

Stargazers

Watchers

Forkers

cnrxomox gurkansahinn aceabhishekofficial psirograpth ipollo abhaysv stley nelsoncoutinho emanico notunlikethewaves akosd127 woscript mysekwel ertanozdemir sl-rp traxyy mrslimcoder gbazera deveoman jarnokai emmett-white galardodev angelompc coool9 ephraim17 fahadtkh leonardssh mergevos nimabastani y-less martynaskasp rsetiawan7 medzvel virsenas iyx rommel-thefox gerardoleone autorojo 00mjk adamslt pkfln ldami ff-agus44 betterchan123 brcgtbc phoenixx14 aghyksa fugionn brazzsamp vince0789 emanicosamp fixlly65 warus65 dariusk0 dennorske bigeti blefony alasnkz carlos-menezes amyrahmady itspitix walter-correa lukman350 robertnorrie sixxt flaspu ksenonadv abielfrl mhyunata sumiheart dentis-t dev-zulan dev-catborisovv jindalpriyanshu101 kyluss25 se8870 artdsl 0xvasic veseon lowkeypanda wiger3 black-z18xe neetoons ohmypxl nixonsiagian eoussama racespeedtime fusez zorono korekkk omcho420 meisalan rewgger li-ght abysalfaqiih hpq-dev evilshadez dejanikk francomellia kanekicraynet

web's Issues

Only use MDXProvider for pages that use MDX files

MDXProvider puts a wrapper around markdown content, but it shouldn't apply to next-mdx-remote content using hydrate, only .mdx files inside the pages/ directory.

This is because those pages style themselves using custom layout, but .mdx files need padding etc.

Docs page on other langs:File index (bs) not found: Not found (index)

If you switch to any language on the home page and then click "docs" it throws out an error on the page:

probably due to an invalid link

getLanguageName.ts need to be modified

In my submission, open.mp The language options on the home page need to be modified.

  "zh-TW": "正體中文/繁體中文",
  "zh-CN": "简化字",

For most other websites, the distinction between simplified and traditional characters is as follows

  "zh-TW": "繁体中文",
  "zh-CN": "简体中文",

Editors section

A section for editors with guides on how to set them up.

https://southclaws.wordpress.com/2014/08/12/improving-productivity-with-sublime-text-installation-tips-tricks/

https://github.com/Southclaws/vscode-pawn

Warnings & Tips Key Tag Translation?!

This is really a small and unimportant thing, but Warnings and Tips are only read on the wiki if they have the English key tag, which means that they cannot be translated. (Warnings, Tips, Caution etc.)

As I said, it is literally a small thing, but it is still an unusual part in the middle of a translated page.

Base typography styles

Some work needs to be done to style documents nicer. Currently it's just a font with defaults.

Quick overview of how styles work:

Inside frontend/styles/ there is a file named base.css and this is the base CSS that will be applied globally to the whole site. This is where to set styles for basic typographic elements such as h1, p, etc...

In the source code, there are two additional styling approaches:

Tachyons: this handles most of the layout via composable classes. The majority of layout and some basic styling is done with these classes. These should not really touch things like typography and colours. Since these are applied to specific layout elements, these are not global (unless its a widely used component). Avoid using Tachyons on widely used components, just use it for structure and layout.
styled-jsx: this does slightly more complex styling that Tachyons does not have classes for. Usually display: grid elements and other specific things. This is generally only used for complex layouts and again should not be used for typography and style.

base.css should not contain classes, or if it does, they should be bound to an element type. Generally you should only be styling typographic elements in this file.

Codeowners can no longer merge into the directories they own

I checked with some codeowners and the same happened with them.

Internationalisation

This is something quite important to the open.mp project: making it easy for communities around the world to access and use open.mp software and documentation.

The wiki site uses Docusaurus v2 and there is currently no internationalisation support: facebook/docusaurus#3317 so we can either wait for support to land or start to introduce translations for pages then migrate to whatever Docusaurus implements when it's ready.

Edit:

For now, use this: https://github.com/openmultiplayer/wiki/blob/master/docs/translations/README.md

Make docs wider for non-paragraph blocks

Paragraphs should be measure for readability, but other content can be full-bleed for clarity.

This definitely applies to tables.

Also h1 headings are stuck on the left:

Categorize functions

Categorize the long list of functions.

Add youtube and twitch links

To footer

Indonesia Translation Progress List

This issues will be updated everytime someone made ID translation updates on wiki.
I took lists from #196 migrating from openmultiplayer/wiki#263

Hallo semuanya, disini aku meminta bantuan kalian untuk membantu aku untuk menerjemahkan wiki ini dengan bahasa indonesia, namun sebelum memulai membantu ada hal yang harus di sampaikan terlebih dahulu agar nantinya tidak salah dan tidak asal-asalan.

Usahakan jangan terlalu terpaku dengan google terjemahan, kalau tidak faham bisa tag @Se8870 atau @rsetiawan7 atau bahkan orang yang kamu kenal.
Diperhatikan, diskusikan, dan cari tahu kata apa yang tepat untuk digunakan di dalam wiki ini.
Selalu beritahu bagian mu agar kita bisa membaginya bersama, tidak seenaknya untuk menterjemahkan suatu hal yang padahal itu sedang dikerjakan oleh orag lain.

Oh iya, ini akan selalu di update setiap ada yang translate indonesia di wiki, mau siapapun itu.
Tinggal komentar aja dibagian mana yang di update atau mention nanti bakal di merge secepatnya.

Itu saja yang bisa aku kasih tau, terimakasih telah membantu memberdayakan wiki ini 👏

List Translation Pages:
client

Common Issues
Crash Addresses

Language (or maybe in general) Glossary

I ran across https://web.archive.org/web/20190415202208/https://wiki.sa-mp.com/wiki/Words and initially thought it had no real value but I realised it does, and it needs to be improved.

New scripters often have no idea of all the new vocabulary introduced, not just by programming, but by SA-MP.

Internationalized routing support for docs

Currently the language select causes a 404 on docs pages.

What needs to happen is the language select should be based on what translations are available for the current page. Then, when the page is navigated to, grab the locale from context and read the translated file on getStaticProps.

During build, we can probably also build a list of all possible translations of each page by trying to walk the same tree with docs/translations/... prefixing the path.

Docs page on other langs: File index (bs) not found: Not found (index)

If you switch to any language on the home page and then click "docs" it throws out an error on the page:

probably due to an invalid link

Move blog posts to ./frontend/content and remove next-mdx plugin

These pages are the only thing that use next-mdx and it would simplify everything by just removing it and using our existing MDX infrastructure for rendering.

So, the blog posts need to be moved to content/en/blog and then we can either make the index renderer [...].tsx so it matches any path or make a new [slug].tsx in pages/blog/

The latter would be simplest and only touch blog code. The former will be slightly more complex but more future proof.

The benefit of doing this is that blog posts can then be translated simply by writing the translated version into the same directory structure in another language directory. We should also add a fallback warning just like docs.

Essentially, all the static content of the site will now be rendered the same way - using the mdx-helpers functions.

Authentication

Potential auth methods:

email/pass
email magic link - no password
login with github: https://docs.github.com/en/free-pro-team@latest/rest/guides/basics-of-authentication
login with discord: https://discord.com/developers/docs/topics/oauth2
login with twitter/others?

I'd rather not store passwords tbh, email magic link would be a good first implementation, and github login isn't too difficult to implement.

Would like some feedback on this from users regarding their preferred methods of authenticating.

Case insensitivity

Docs pages are currently case sensitive - because the site is run on a linux environment which is case sensitive.

Not entirely sure how to solve this one. Probably just lowercase everything or do a glob search at build time...

Automatically open the docs sidebar to the currently displayed page

Duplicated server listings with multiple IPs

There might not be a nice easy way to filter these, it might just come down to manual admin action to remove servers.

Edit button for each docs page

Each page needs an "Edit this page" button that just directs to GitHub using the same file with /edit/ in the path.

open.mp wordmark in chrome needs to satisfy chrome's stupid broken svg implementation

doesn't work in chrome so... fuck knows

🤡

TextDrawCreate canvas

The x,y coordinate is the top left coordinate for the text draw area based on a 640x448 "canvas" (irrespective of screen resolution).

I think it should be 640x480.

Cannot changing locale path to default.

I cannot even access open.mp without /id path i mean always redirect to /id path as you can see in this gif below:

Add more pages to nav

Nav currently just has Home, Servers and Docs - which is nice and minimal, but there's also some temporary links to add:

missing-sites
progress
blog

Render newly added pages in pull requests at build-time

Currently, most pages are pulled from the API at render time in order to reduce build times. Unfortunately, this means that pages added via pull request don't get built and are missing when previewed - this kind of defeats the purpose of using Vercel now, at least for documentation contributors. The preview tool is vital for catching formatting errors for documentation markdown.

So, the solution for this that doesn't involve 20+ minute build times is to pass a set of pages to getStaticPaths which are any files modified in the current diff against master branch inside the docs/ directory.

Hopefully this won't be too hard:

Detect if the build is preview and not prod by using VERCEL_ENV
Run git diff master HEAD --name-only -- docs to get a list of files that this current PR touched in docs/
Pass those paths to getStaticPaths

Polish translation checklist

This issue contains a checklist of Polish translations, so everyone who wants to contribute can check which pages are missing. You can also discuss here about translation quality or notify me, if I haven't updated the list with your contribution yet.

Tutaj znajdziesz listę kontrolną polskiego tłumaczenia, więc każdy kto chce pomóc może sprawdzić, których stron brakuje. Można tutaj także dyskutować o jakości tłumaczenia lub powiadomić mnie, jeżeli jeszcze nie zaktualizowałem listy z Waszymi zmianami.

meta

Contributing.md

scripting/callbacks

scripting/functions

scripting/language

scripting/resources

scripting/resources/_server

controllingaserver.md
lagcompensation.md
remoteconsole.md
server.cfg.md

tutorials

Site not replace `.md` when clicking to `related functions`

Clicking link on Related Functions may result 404 because didn't remove .md part.

Meta tags for embeds/previews/SEO

These need to be ported from the old homepage, as well as for docs, but that's a little more complicated so it deserves its own issue.

Contents for docs pages

Would be neat to replicate this:

Can be done at static build time using MDX to walk the AST and find all the heading nodes.

Fix VersionWarn templates

These originally were using remark admonitions but this doesn't work any more because the plugins run before the elements are executed so this means it just results in the raw :::warning text instead of the actual typographic elements.

Possible solution: finish #7 so they have styles, then just make the VersionWarn component ouput a raw HTML (JSX) admonition.

Open.mp masterlist issue.

I noticed a odd issue with the masterlist on the website.

My server recently moved to a new ip. I added the new ip to the masterlist via the ip/domain add feature. My old ip that is no longer used shows the server as online, and the new ip seems to have been removed.

Old Ip:167.114.104.51:7777
New: 149.56.185.92:7777

Portuguese (PT) translation progress

OBS: Alguns arquivos serão marcados como NDA (Necessita de Atualização) mesmo após serem marcados como traduzidos.
Caso deseje contribuir, verifique-os também!

client

CommonIssues.md
CrashAddresses.md
ClientCommands.md

meta

Contributing.md

server

scripting/callbacks

scripting/functions

scripting/reference

scripting/language

scripting/resources

tutorials

Mobile friendly nav

The current nav is fine on mobile, but it won't fit any more buttons on it so we need a mobile friendly nav for more options.

Server listing verification

For users to edit their listing and augment it with additional information like a description, images, graphs, etc.

That verification process must be as simple as possible and cover as many users' skill levels.

Here are some ideas:

Generate a curl/wget/Invoke-WebRequest command that the user calls from their server that includes a unique token to prove they own it
Build a simple announce.exe binary
Put some unique token in the gamemode/hostname/map just once
Procedurally generate an .amx filterscript that can be loaded once - it would make a HTTP call with the token built into the binary

Unified language dialect (Colour vs Color!)

A lot of our files use English and a lot use American-English.

Consistency is important and it seems American-English is winning in terms of numbers. Also the natives themselves use AE.

Animations wiki page doesn't work

https://open.mp/docs/scripting/resources/animations

Functions and Events: NPC API

The NPC API has been missing from the wiki for a while.

I don't think it deserves its own section, but definitely needs admonitions on each page to indicate the APIs are only for use within NPC scripts.

https://web.archive.org/web/20190808191615/https://wiki.sa-mp.com/wiki/Category:NPC

The NPCs (Non-Player Characters, also known as 'bots') are a feature introduced since SA-MP 0.3. This new feature allows you to add one or more NPCs inside your server who will work like 'virtual players'. They use a server slot, just like a player would do. What the NPCs do inside your server is scripted using PAWN scripts. The scripts with the 'artificial inteligence' of each NPC isn't scripted inside the gamemode file, nor in a filterscript. They use their own compiled scripts for this task, which have to stay inside the npcmodes directory. That is, if you want to have 20 different NPCs doing different things, you will most likely have to have 20 pawn compiled scripts inside the npcmodes directory. This doesn't mean that you can't use the normal player functions applied to your NPCs (like SetPlayerPos, for example) from inside a gamemode or filterscript.

Each NPC runs in its own process. This can make better use for multi-core proccesors. The new NPC feature adds some more callbacks and functions which can be used just inside NPC scripts. Normally, these scripts just include the a_npc include file, and not the a_samp one as most gamemodes and filterscripts do. There are also a couple of added functions which work in gamemodes and filterscripts to make easier the NPC handling.

The following resources are exclusive for NPC scripts, unless otherwise is stated:

Add notes to GetVehicleTrailer

Add below 'This function does not work for train' also 'This function will return 0 if a player isn't near (10mt or less) the vehicleid specified'.

Landing page design

I know a lot of people didn't expect or understand the reason for the sudden website change, so I'll quickly explain that here as I don't think it's written down all in one place:

There were primarily two problems:

Docusaurus is slow as heck to build and to use. We saw performance issues on high end machines so it doesn't deal well with over 1000 pages.
There was some serious HTTP redirect/rewrite spaghetti happening behind the scenes to make the docs site work properly! The main site sat on the open.mp domain. The wiki was not hosted on a domain, but we had to make it work on open.mp/docs so it used HTTP rewrites to achieve that. All 404s were rewritten to wiki.openmultiplayer.vercel.app which ran the wiki in order for assets on / on both sites worked. This meant 404s on the main site were confusing. It also meant that page loads resulted in at least one HTTP rewrite and maybe two HTTP redirects. Also wiki.open.mp introduced more complexity. It was a big mess that just so happened to work!

So the new site was built very quickly in order to serve those of the community who wanted to browse the documentation without a supercomputer and those who wanted to contribute to the wiki without waiting 20 minutes for a preview to build.

As a result, it's quite plain looking. Functionality comes first! And yes I'm working on search.

End of explanation

So with that out of the way...

This is a good opportunity to get the community involved. Post your design idea/inspiration here and we can open a discussion about what the new site can look like!

Here's a list of assets:

Graphic assets: https://github.com/openmultiplayer/graphics/
Rendered graphics: https://assets.open.mp/minio/assets/images/assets/
Brand colour: #8477b7
Off-white: #dfdfdf
Off-black: #2c2d2d
Colour scheme tool: https://color.adobe.com/create
Brand headings typeface: English Grotesque

English language button doesn't redirect to the correct route

My browser language is set to Italian, so if I go on open.mp/ it'll redirects me to open.mp/it.

When I click the language selection button to select the English language, it won't redirect to open.mp/en but instead it redirects to open.mp/

Steps to reproduce the bug:

Set your browser language to one that isn't English;
Click the button to select the language;
Select English.

Category pages - with a list of sub-pages

Cloudflare's docs site does this:

Basically, each category heading also needs its own page. So you can link to a collection of pages easily, like /functions or /callbacks.

But, as a bonus, it would be really neat to be able to write custom content for these pages too. So maybe introduce a special page that can exist inside each directory named _index.mdx or something where you can write text and then underneath this text is an automatically generated list of pages.

Add Urdu (ur) Translations

Urdu translation progress:

Client:

CommonIssues.md
CrashAddresses.md
ClientCommands.md

Meta:

Contributing.md

Server:

Callbacks:

Functions:

Language:

AdvancedStructures.md
Binary.md
MenuGuide.md
PickupGuide.md

Tutorials:

Fix admonitions

I think this just needs styling, there are classes that admonitions are given so you just need to style those.

Don't put this in base.css, make a new file and import it into _app.tsx

This won't affect admonitions done via though, that needs another solution... #8

Improving tutorial effectiveness

What
3 ideas to help with making the tutorials more effective. Some of these may apply to the rest of the docs as well.

Links to fiddles/potentially embedding fiddles in docs
Subdivision of topics into 2 categories: Theory and Application
Small "Check your understanding" sections at the end

I don't believe the capability to embed pawn fiddles exists as of now. In any case, links to tutorial fiddles can be helpful in providing a faster feedback loop when reading about a subject.

Check your understanding sections would be simple multiple choice/fill in the blanks questions that serve the same purpose as the fiddles. Could be done simply by putting the correct answers within a spoiler tag or by adding some functionality into the docs that would check for right answer, etc. Practically, the spoiler seems to be the winner but the built-in docs option would, in my opinion, lead to more engagement/better results.

Topics in tutorials can always, if not for the most part, be classified into those two categories. There would be no restriction for a topic to have both theory and application, but for the most part you're always applying some concept that you can link back to. Here too, I can think of two ways of supporting it:

Simple notice at the top of each post redirecting to the other one: "This is the theoretical foundation for X. For application(s), see: [1 or more links]." and "This is an application of X. If you need to go over the concepts, see: [1 or more links].".
Tags/groups/some way of linking one post to the other. This has the added benefit of grouping all theory posts together, and all applications together, allowing people to either do all theory first then applications, or theory-application and so on.

The first one is the easier to put in place, but the benefit of grouping these can prove useful as more tutorials are added.

Why
The better readers of a tutorial grasp the concepts at play, the better. I believe I have offered some good arguments above as to how these additions would improve the effectiveness of tutorials. I have also tried to include different ways that they could be implemented, with their advantages/disadvantages.

Curious to see your feedback on this: eager to see additions/modifications/removals, or comments.

Search

The site needs search support.

Docsearch doesn't seem to work so we can just build our own index at build time.

Meta tags for documentation pages

#22 is for the site itself, but docs pages also need to generate their own title/description meta tags.

This can be done by parsing the frontmatter.

Not sure where to do this yet. Probably at build time.

Clientside page transitions error sometimes

Something about props destructuring on undefined. Doesn't happen in local dev, only in prod. Possibly next.js bug or something up with mdx remote hydrate

Port over progress page

This wasn't added because it requires a github token, but I want to keep build logs public so contributors can debug things.

So, I think we should move the actual GitHub query to the backend - just to simplify the frontend so it doesn't have an API component.

Or move it to a simple cloudflare worker or something.

Use next/image for documentation image optimisation

Need to swap out img for Image in MDXContext