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

Document setting up a gps constellation #1070

Closed
wants to merge 20 commits into from

Conversation

Lupus590
Copy link
Contributor

related: #1068

doc/guides/gps_setup.md Outdated Show resolved Hide resolved
doc/guides/gps_setup.md Outdated Show resolved Hide resolved
doc/guides/gps_setup.md Outdated Show resolved Hide resolved
doc/guides/gps_setup.md Outdated Show resolved Hide resolved
doc/guides/gps_setup.md Outdated Show resolved Hide resolved
doc/guides/gps_setup.md Outdated Show resolved Hide resolved
doc/guides/gps_setup.md Outdated Show resolved Hide resolved
@SquidDev SquidDev added enhancement An extension of a feature or a new feature. area-Documentation Improving/fixing documentation labels Apr 27, 2022
there's a few more but these are the ones that I think are good changes
@Lupus590 Lupus590 marked this pull request as ready for review April 29, 2022 00:19
@SquidDev SquidDev changed the title document setting up a gps constellation Document setting up a gps constellation May 18, 2022
doc/guides/gps_setup.md Outdated Show resolved Hide resolved
doc/guides/gps_setup.md Outdated Show resolved Hide resolved
doc/guides/gps_setup.md Outdated Show resolved Hide resolved
:::

## A brief look at how the GPS API works in CC
Except for command computers and user code overrides, ComputerCraft mimics real-life GPS; computers trilaterate themselves using signals with known sender positions (which is why we have to tell the GPS hosts where they are). This means that the average CC computer will need a wireless modem and be in range of a GPS constellation.
Copy link
Member

Choose a reason for hiding this comment

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

What do you mean by "the average CC computer"? I assume you're referring to non-command ones here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, non-command computers is what I'm trying to say.

Copy link
Member

Choose a reason for hiding this comment

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

Yeah, I'd just leave that off then.

I'm not really sure about this section in its current state. Right now it really boils down to "it's Trilateration!". I don't know if we want a couple of sentences explanation, or just drop it entirely.

@Lupus590 Lupus590 requested a review from SquidDev June 1, 2022 19:58
Copy link
Member

@SquidDev SquidDev left a comment

Choose a reason for hiding this comment

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

Sorry, been thinking about this a chunk more, and I think I'm going to propose another awkward restructuring. Content is good, it's just a little hard to follow along right now!

I think the main thing we want to do is merge the "Building a GPS constellation" and "Configuring the constellation" sections and then make them as step-by-step as possible. Maybe even write this as a list (not sure, that might be a bit too much!)

So literally something like:

  1. You will need: (4 computers, 4 wireless modems). Maybe worth briefly mentioning the ender/wireless tradeoff here. Maybe mention you'll need wireless modems (but either kind is fine) for each computer which needs to find its position with GPS.

  2. Find a place to build (talk about the size requirements, maybe mention it's better to be build with non-ender modems higher up (though I'm not sure this is true on 1.18, haven't done the maths with the new world height!)

  3. Place down one computer and modem, talk about F3, write the startup file with them.

  4. Talk about the next three computers. Honestly, I'd be much more prescriptive about this (get them to build the exact layout you've got in the screenshot).

Then maybe get them to test this with another computer and confirm the position is correct.


I don't know! I'm obviously not a beginner here, and haven't ever used the built-in GPS server (always rolled my own >:D), so do feel free to say if you disagree!

doc/guides/gps_setup.md Outdated Show resolved Hide resolved
doc/guides/gps_setup.md Outdated Show resolved Hide resolved
:::

## A brief look at how the GPS API works in CC
Except for command computers and user code overrides, ComputerCraft mimics real-life GPS; computers trilaterate themselves using signals with known sender positions (which is why we have to tell the GPS hosts where they are). This means that the average CC computer will need a wireless modem and be in range of a GPS constellation.
Copy link
Member

Choose a reason for hiding this comment

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

Yeah, I'd just leave that off then.

I'm not really sure about this section in its current state. Right now it really boils down to "it's Trilateration!". I don't know if we want a couple of sentences explanation, or just drop it entirely.


In order to use GPS, you'll need to set up multiple GPS hosts. These are computers running the special gps host program, which tell other computers the host's position. Several hosts running together are known as a GPS constellation.

Before GPS can be used in a dimension (e.g. the Nether) a GPS host constellation needs to be set up. Traditionally this is done near the max build height for maximum range, but ender modems easily beats a normal modem's max range at any height.
Copy link
Member

Choose a reason for hiding this comment

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

The first bit of this kinda duplicates the previous paragraph now.

I think I'd probably drop this paragraph (and the one below) and then mention these considerations in the "Building a GPS constellation" section.

doc/guides/gps_setup.md Outdated Show resolved Hide resolved
@Lupus590 Lupus590 requested a review from SquidDev June 2, 2022 08:34
@Lupus590
Copy link
Contributor Author

Lupus590 commented Jun 2, 2022

I decided to keep the two sections just in case someone is reading the guide because they remember one half but not the other.

Building it is quite different to configuring it so I figured that I'd keep the distinction.

Copy link
Member

@SquidDev SquidDev left a comment

Choose a reason for hiding this comment

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

Thank you! Just a couple of small things.

doc/guides/gps_setup.md Outdated Show resolved Hide resolved
doc/guides/gps_setup.md Outdated Show resolved Hide resolved
doc/guides/gps_setup.md Outdated Show resolved Hide resolved
doc/guides/gps_setup.md Outdated Show resolved Hide resolved
doc/guides/gps_setup.md Outdated Show resolved Hide resolved
@Lupus590 Lupus590 requested a review from SquidDev June 6, 2022 22:12
@SquidDev
Copy link
Member

SquidDev commented Jul 2, 2022

Really sorry for taking so long to look at this again, thank you so much for your patience in my many requests! Merged manually in d6afee8.

@SquidDev SquidDev closed this Jul 2, 2022
@Lupus590 Lupus590 deleted the docs/gps_setup branch July 2, 2022 19:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-Documentation Improving/fixing documentation enhancement An extension of a feature or a new feature.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants