oeed / CraftOS-Standards

Community standard file formats, communication systems, etc. for ComputerCraft and CraftOS 2.0
Other
20 stars 16 forks source link

Communication Standard Template #45

Open oeed opened 8 years ago

oeed commented 8 years ago

A template is required for communication standards. The existing template needs to be renamed to indicate that it is specific to file formats. There should also be a templates folder, unless there's some way you've integrated these in on tutorial @viluon?

ghost commented 8 years ago

@oeed ooops I was so dumb, I wrote one into the rednet pull request, it is in there...

ghost commented 8 years ago

oh, this is an issue, not a pull request, I´m not very familiar with Github yet.

oeed commented 8 years ago

No problem! Yeah, so for this project, issues are basically TODOs that (basically) anyone can do whereas pull requests are changes that need to be approved.

viluon commented 8 years ago

Agreed @oeed, I'll rewrite templates in tutorial. I'll post updates about the progress here (will change from todo to work in progress when I actually start committing).

oeed commented 8 years ago

To be honest @viluon I really think we need to get tutorial merged ASAP, it's leaving master lagging too far behind where we need it.

Can we maybe merge it and instead make smaller branches?

viluon commented 8 years ago

I was just thinking about that, let's talk on Gitter @oeed (this is an unrelated Issue).

ghost commented 8 years ago

I´ve got an idea for templates, see #46

oeed commented 8 years ago

As mentioned in #47, there is quite a difference between transmission methods and protocols. Hence, we actually need two different templates.

ghost commented 8 years ago

@oeed I think Rednet in a protocol too, but we should add another header Table Row, which contains Information if it can be used as Transmission Method. And Rednet is currently the only ProtocolAndTrasmissionMethod thing. (once its accepted, I´ll release some Protocols based on Rednet)

oeed commented 8 years ago

I might be wrong, but I feel like a protocol is more about data being sent, not the method being sent. But I can see what you're saying.

@demhydraz or @viluon do you have any thoughts on this?

oeed commented 8 years ago

Right, so one could say that protocols are to transmission methods what data formats are to file systems?

In that case, yes there needs to be two.

On 11 Feb 2016, at 10:15 PM, Matheus Magalhães de Alcantara notifications@github.com wrote:

As mentioned in #47, there is quite a difference between transmission methods and protocols. Hence, we actually need two different templates.

This is right. Rednet is a transmission method. And something that'd send diffs along for file updating (say, like rsync/ftp) is a protocol.

— Reply to this email directly or view it on GitHub.

ghost commented 8 years ago

Yes, but there are also Transmission Methods which are Protocols. (like a file system in a file)

as writing this I got an Idea: Why don´t Sort them in Folders like that:

=Communication
 =Modem
  -README.md
  -gps.md
  =rednet
   -README.md
   -chat.md
   -dns.md

or

=Communication
 =Modem
  -gps.md
  -rednet.md
  =rednet
   -chat.md
   -dns.md

maybe also without a modem folder

the upper variant will easily show, which Protocol is based on which and also would view TransmissionMethodProtocols as Folder which is easy to understand. The only problem is that I think File names with just big chars should be meta...

EDIT: that would also provide the need for 2 different templates

ghost commented 8 years ago

@demhydraz Rednet for example, or maybe just rednet

oeed commented 8 years ago

@justsomeoneelseagain a protocol defines what the data is you're sending and how to parse it. A transmission method is simple a road for the data to go down.