Git Product home page Git Product logo

old-documentation's Introduction

Decentraland documentation

Setup

  1. Add your site and author details in _config.yml.
  2. Add your Google Analytics, Disqus and MailChimp keys to _config.yml.
  3. Get a workflow going to see your site's output (with CloudCannon or Jekyll locally).

Develop

Base was built with Jekyll version 3.8.4, but should support newer versions as well.

Install the dependencies with Bundler:

$ bundle install

Run jekyll commands through Bundler to ensure you're using the right versions:

$ bundle exec jekyll serve --incremental

While jekyll is running, you can open the locally hosted version of the docs site on a browser, using http://127.0.0.1:4000/. As you make changes to the source material, the generated site should be updated when reloading.

Develop (Docker)

if you have Docker you also can run your development environment with the follow command

docker run --rm -p 4000:4000 \
  --volume="$PWD:/srv/jekyll" \
  --volume="$PWD/.vendor/bundle:/usr/local/bundle" \
  -it jekyll/jekyll:3.8.4 \
  jekyll serve --incremental

Editing

Please use Visual Studio Code with Prettier extension to have a consistent coding style

Posts

  • Add, update or remove a post in the Posts collection.
  • The tutorials page is organised by categories.
  • Change the defaults when new posts are created in _posts/_defaults.md.

Menu

  • Add post to menu editing _data/menu.yml

Navigation

  • Exposed as a data file to give clients better access.
  • Set in the Data / Navigation section.

Footer

  • Exposed as a data file to give clients better access.
  • Set in the Data / Footer section.

Base template was made by CloudCannon, the Cloud CMS for Jekyll.

old-documentation's People

Contributors

2fd avatar abarmat avatar aviaisenberg avatar converg3nce avatar deepansh96 avatar dependabot[bot] avatar din3 avatar dnul avatar doomling avatar drsaveyourass avatar eibrielinv avatar eordano avatar fmiras avatar fzavalia avatar ginocingolani avatar hprivakos avatar juanigallo avatar katherinejoelle avatar lautaropetaccio avatar leohgc avatar lyricalpolymath avatar menduz avatar nachomazzara avatar nchamo avatar nearnshaw avatar nicosantangelo avatar schallock avatar shibuyamartin avatar tserg avatar yemel avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

old-documentation's Issues

Broken Homepage Styling

I know this has nothing to do with the docs, but I couldn't find a proper place to put this issue. The UI on the main page of Decentraland.org breaks on resizing.

screen shot 2018-10-12 at 9 31 46 am

dcl start. TIMEOUT

What?
[HPM] Error occurred while proxying request 127.0.0.1:8001/lambdas/health to https://peer-lb.decentraland.org/ [ETIMEDOUT] (https://nodejs.org/api/errors.html#errors_common_system_errors)
...

Why?
āœ” Latest SDK installation found.
āœ” Checking decentraland libraries

[email protected] watch /Users/francis/Develop/test/francis_test/dcl
build-ecs --watch

dev mode: true
working directory: /Users/francis/Develop/test/francis_test/dcl

processing /src/MyPrompt.ts
bundling:

node_modules/@dcl/amd/dist/amd.js
node_modules/decentraland-ecs/dist/src/index.js
node_modules/@dcl/ui-scene-utils/dist/index.js
src/MyPrompt.ts
writing /bin/game.js
writing /bin/game.js.lib

The compiler is watching file changes...

[HPM] Proxy created: / -> https://peer.decentraland.org/
[HPM] Proxy created: / -> https://peer.decentraland.org/

Preview server is now running

Available on:

http://127.0.0.1:8001?position=0%2C0&SCENE_DEBUG_PANEL
http://192.168.0.139:8001?position=0%2C0&SCENE_DEBUG_PANEL
Details:

Press CTRL+C to exit

Acquiring comms connection.
[HPM] ECONNRESET: Error: socket hang up
at connResetException (internal/errors.js:639:14)
at TLSSocket.socketCloseListener (_http_client.js:449:25)
at TLSSocket.emit (events.js:412:35)
at net.js:686:12
at TCP.done (_tls_wrap.js:564:7) {
code: 'ECONNRESET'

...

[HPM] Error occurred while proxying request 192.168.0.139:8001/lambdas/health to https://peer.decentraland.org/ [ECONNRESET] (https://nodejs.org/api/errors.html#errors_common_system_errors)
Acquiring comms connection.

FAQ candidate: "Where is everyone?"

I was curious about this project so I take a look and was really impressed but I couldn't help but wonder "Where is everyone?!" I noticed the "Friends" section but I don't know anyone using the platform. I thought to myself "maybe I can only see people who are my friends" and then "...but how do I make friends?". I found the events section and wondered whether or not everyone attending an event could see each other or not.

So, has this place just been a ghost town or am I missing something? I tried looking for people on the map too.

For any prospective investor in decentraland, it appears obvious that the value of one's investment depends upon the "network effect" so I think making all this clearer could be a great boon to your platform. Hope to be interacting soon.

Showcase Bitvavo in the MANA wallet docs

Dear MANA team,

We are contacting you on behalf of Bitvavo, one of the biggest regulated EUR exchanges in Europe. We are proudly based in Amsterdam and have been offering the MANA/EUR trading pair to our customers for some time now. According to data from CoinMarketCap we currently provide a top 3 MANA market worldwide based on EUR volume.

In your docs we saw the page https://docs.decentraland.org/examples/get-a-wallet/ where you showcase 3 exchange options for MANA. We were wondering: can you add Bitvavo to this list? We created a custom asset page https://bitvavo.com/en/decentraland that you could link to (for localized versions, just replace "en" with "de", "es", "fr", "it" or "nl" in the link).

Thank you for considering the opportunity to add Bitvavo to the list of exchanges.

Kindly let us know if you have any questions.

deploy dcl start to a server

We are trying to put the stable version of the scene that we are working in our sever and we have a custom url and behind a nginx but when I connect to an instance of Ā“dcl startĀ“ on another computer using a domain name it gives me this error in top of the loading screen in a red box:
Critical error

  • The realm v1~ isn't available right now.
  • Catalysts Contract could not be queried
  • The realm v1~ isn't available right now.
  • The realm v1~ isn't available right now.

And in the browse developer console:
WebSocket connection to 'wss:///?identity=MHhmYzViZDRmYWZmMzIxMjBmYWI4MzhlM2FhNTU0YWNmODcxMDQxOGRl' failed:
(anonymous) @ index.js:84
connectWS @ index.js:84
connect @ index.js:84
connect @ index.js:86
connect @ index.js:52
t.connectComms @ index.js:61
C @ index.js:61

Uncaught TypeError: Cannot assign to read only property 'solana' of object '#<Window>'

View details in Rollbar: https://rollbar.com/decentraland/documentation/items/28/


TypeError: Cannot assign to read only property 'solana' of object '#<Window>'
  File "chrome-extension://afbcbjpbpfadlkmhmclhkeeodmamcflc/inject_start.js", line 411, in Function.loadInjectObjectsOfSolana
  File "chrome-extension://afbcbjpbpfadlkmhmclhkeeodmamcflc/inject_start.js", line 411, in Tt.dispenseInjectMessage
  File "chrome-extension://afbcbjpbpfadlkmhmclhkeeodmamcflc/inject_start.js", line 411, in [anonymous]
  File "chrome-extension://afbcbjpbpfadlkmhmclhkeeodmamcflc/inject_start.js", line 210, in HTMLDocument.<anonymous>

Subcategories are not displayed on mobile navigation

Secondary-level navigation items on the Docs category are not displayed on the dropdown on mobile. The expected behavior should be the same of navigating in desktop, the user clicks on Docs and then all the secondary-level navigation items are displayed below (World, Market, Create & Ethereum Essentials)

Can't find variable zoomDisable

View details in Rollbar: https://rollbar.com/decentraland/documentation/items/3/


ReferenceError: zoomDisable is not defined
  File "https://docs.decentraland.org/js/global.js", line 383, in HTMLDivElement.<anonymous>
  File "https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.min.js", line 2, in HTMLDivElement.dispatch
  File "https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.min.js", line 2, in HTMLDivElement.y.handle
  File "https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.min.js", line 2, in Object.trigger
  File "https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.min.js", line 2, in HTMLDivElement.<anonymous>
  File "https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.min.js", line 2, in Function.each
  File "https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.min.js", line 2, in w.fn.init.each
  File "https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.min.js", line 2, in w.fn.init.trigger
  File "https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.min.js", line 2, in w.fn.init.w.fn.<computed> [as click]
  File "https://docs.decentraland.org/js/global.js", line 341, in sendingFeedback

connection listeners do not trigger

onPlayerConnectedObservable, onPlayerDisconnectedObservable all do not trigger in my test scene. I implement the listeners as described here: https://docs.decentraland.org/development-guide/event-listeners/ and they do not seem to trigger.

I am able to trigger events for onIdleStateChangedObservable, onPlayerExpressionObservable, , onEnterSceneObservable, onLeaveSceneObservable, and OnPointerDown, am I just forgetting to import something? Or am I just implementing my code incorrectly?

I add my listeners at the top of my scene file, but I don't seem to get an output.

How to add multiple listeners to custom events?

The documentation page "https://docs.decentraland.org/development-guide/custom-events/" states that to add a listener you have to call "events.addListener()".

That works for a single listener, but when adding a second one with the second parameter being "null", the error "The provided listener is already registered" is thrown.

The documentation should be more detailed instead of just saying "The listener to use. This will almost always be null." about the second parameter of the "addListener" function.

Link to inaccurate information

The documentation on page https://github.com/decentraland/documentation/blob/master/_posts/development-guide/2018-02-6-shape-components.md links to https://github.com/decentraland/ecs-reference , an outdated (or inaccurate) documentation that don't have Issues tab enabled.

An example of inaccurate information is the page https://github.com/decentraland/ecs-reference/blob/master/docs-latest/decentraland-ecs.textshape.md where many properties don't have any effect.

Maybe the information on decentraland/ecs-reference should be rebuilt?

Uncaught Error: Syntax error, unrecognized expression: #check-the-player's-camera-mode

View details in Rollbar: https://rollbar.com/decentraland/documentation/items/7/


Error: Syntax error, unrecognized expression: #gid=0
  File "https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.min.js", line 2, in Function.oe.error
  File "https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.min.js", line 2, in oe.tokenize
  File "https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.min.js", line 2, in oe.select
  File "https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.min.js", line 2, in Function.oe [as find]
  File "https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.min.js", line 2, in w.fn.init.find
  File "https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.min.js", line 2, in new w.fn.init
  File "https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.min.js", line 2, in w
  File "https://docs.decentraland.org/js/global.js", line 316, in HTMLAnchorElement.<anonymous>
  File "https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.min.js", line 2, in HTMLAnchorElement.dispatch
  File "https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.min.js", line 2, in HTMLAnchorElement.y.handle

Polygon Testnet setup lacks Chain ID

This page:
https://docs.decentraland.org/development-guide/second-layer/
at the bottom, provides info about how to hook MetaMask up to Polygon test net.
However the info isn't quite complete, it lacks the Chain ID

Although it links to the Polygon docs where the full information is, providing part of the info but not all of it seems less than ideal.

Here is the full info from the Polygon site:

Network Name: Polygon Mumbai Testnet
New RPC URL: https://polygon-mumbai.g.alchemy.com/v2/your-api-key
ChainID: 80001
Symbol: MATIC
Block Explorer URL: https://mumbai.polygonscan.com/

No Token Id from API

Is there a way to get the Token_Id directly from an API call? If not would I go about converting the encoded_id?

Per-page wording, misspellings, broken links, etc

I'll do my best to keep this list readable, I think it's a bit more manageable to keep it all in one place but let me know if I should open several issues instead.

Most of the feedback is about minor inconsistencies and misspellings, but some of it is mostly my opinion. I'll try to highlight those, you can do with it what you think is best.

Feedback

https://docs.decentraland.org/documentation/introduction/

  • thru -> through (thru is only for informal communication)

  • speed up development times -> speed up development time

https://docs.decentraland.org/documentation/create-scene/

  • In Decentraland, a scene is the representation of the content of in an estate/LAND => what does the content *of in an* estate/LAND mean?

  • Type Script scenes => TypeScript scenes

  • end users of your parsel will see => end users of your parcel will see

  • The only thing it really does is => Opinion This is a weird way to phrase it. Maybe It really just... ?

  • To preview your rendered scene locally (without uploading it to IPFS)Ā => Opinion This is the first time IPFS is mentioned, confusing for the uninitiated. I started from developers.decentraland.org which took me to Building scenes-> Introduction. Maybe a link to https://docs.decentraland.org/decentraland/ or to https://docs.decentraland.org/documentation/publishing/#what-is-ipfs ?

  • To edit a scene, we recommend using an IDE likeĀ Visual Studio Code. => VSCode isnā€™t really an IDE

  • Next Step: Decentraland Introduction => Is that ok?

https://docs.decentraland.org/documentation/publishing/

  • Your scene complies with all of theĀ scene limitations => Broken link
  • Otherwise you can purchase LAND in theĀ Market => Broken link
  • Note:Ā  => are those necessary? the indented block already serves as a ā€œNote:ā€ and was not there before
  • Advanced samples => Examples have links without capitalisation

https://docs.decentraland.org/documentation/mvp-guidelines/

  • Next Step => Takes me to Scene limitations, is that ok?

  • Opinion This was a bit of a surprise. Reading from top to bottom I expected to find information about how the SDK worked and not how should I build an MVP. Not saying it's useless information, just the placement seemed weird. Also the reference to the persistent core loop when the docs told me there wasnā€™t any loop before threw me off.

https://docs.decentraland.org/sdk-reference/SDK-Overview/

  • Locally-run scenesĀ - or dynamic => or? dynamic. It doesnā€™t say static anywhere. (same with Remotely-run)

  • For additional terms, definitions, and explanations, please refer to ourĀ complete Glossary. => Broken link

  • the SDK, please refer to the **SDK Quick Start Guide** => are the asterisks necessary?

  • please read ourĀ SDK Quick Start GuideĀ or theĀ CLI Tutorial => CLI Tutorial is a broken link

  • Next Step => Not the same as the sidebar again. Won't point this out again.

https://docs.decentraland.org/sdk-reference/scene-content-guide/

  • Tip: When editing the code via a IDE (like Visual Studio Code) => VSCode is not an IDE

  • Transition code example: <box rotation={currnetRotation} => currentRotation*

  • Another code example: <box rotation={currnetRotation} color={currnetColor} scale={currnetScale} => current*

  • Materials are also implicitly imported into a scene when you import a gtLF => should be glTF ?

  • This is useful, for example, to verify that animations are properly attached and their names. => and their names what?

  • Question: Why is the sound property a string instead of an object?

  • When using the liner or exponential model => linear*

  • Entities that have collision disabled can walked through => can be walked through ?

  • In Entity Collisions the code snippet says ignoreCollisions="falseā€, shouldnā€™t it be ignoreCollisions={false} (itā€™s not xml) ?

  • Decentralan currently doesnā€™t have a physics engine => Decentraland*

  • No Next Step

https://docs.decentraland.org/sdk-reference/event-handling/

  • The The click event example shows that this.setState is a synchronous operation, this differs from React and confused me a bit. Should this be on a callback?

  • AĀ simpler way to deal with clicks that are done on a single entity => AĀ simpler way to deal with clicks made on a single entity ?

  • Note:Entity-specific => missing space after Note:

  • Entity-specific click events

    • this.eventSubscriber.on('redButton_click', ()) => { => Syntax error on ()) =>
    • missing ; at the end of the call
  • Pointer down and pointer up

    • Class name is not PascalCased
    • buttonState starts as false instead of 0
  • Rotation change

  • General missing ; in all import statements

https://docs.decentraland.org/sdk-reference/scene-state/

  • Set the state code example indented strangely

  • The only exception to this is if theĀ shouldSceneUpdate()Ā functionĀ is set up to prevent. => to prevent it* ?

  • Reference the state code example indented strangely

  • theĀ render()Ā method draws a dynamic scene where the position of an entity is based on a variable in the status => of an entity is based on a variable in the state*

https://docs.decentraland.org/sdk-reference/entity-interfaces/

  • or include theĀ ignoreCollisionĀ component to change how it reponds to collisions with other entities => wasnā€™t ignoreCollision an attribute/property?

  • Same comment as above about VSCode

  • Box this is the only code example where the position looks like this: { { x: 5, y: 0, z: 2 } } instead of {{ x: 5, y: 0, z: 2 }}

  • Base Entity

    • First code example: scale={{ x: 2, y: 2, z: 0.0 5 }} five on the loose!
  • Materials this is the only Interface definition that doesnā€™t have newlines between properties

https://docs.decentraland.org/sdk-reference/scriptable-scene/

  • Lifecycle methods

    • The class on the code sample is missing the state declaration. There are floating propertiesā€Ø eventSubscriber: EventSubscriber; timer: number; state: State = { counter: 0 }
    • Where does EventSubscriber come from?
    • sceneDidMount has lingering asterisks on the comment
    • maybe just return this.state.counter < 20 on shouldSceneUpdate ?
    • The summarized steps change the font size on the 4th item
  • Low-level API

    • Once the class is created, it requires an instance of EntityController to the host (ā€¦) => requires an instance from* the host?
    • (ā€¦) (the engine) , this is an asynchronous call. => there a space before the comma

https://docs.decentraland.org/documentation/scene-limitations/

  • thru -> through (thru is only for informal communication)

  • Using Blender Render, any of its shaders are supported, that includes diffuse, specular, transparency, etc => all* of its shaders are supported ?

General

  • Next Step and Related documents -> Maybe Related Documents should be to the left and Next Step to the right? I think that it follows what I'm reading better, as is indented to the right. Maybe capitalise documents or lowercase Step?

  • XML/React like Code in the SDK Entity interfaces (https://docs.decentraland.org/sdk-reference/entity-interfaces/) looks a lot better than in Scene Content guide (https://docs.decentraland.org/sdk-reference/scene-content-guide/) probably because of the language set for the syntax highlighting

  • Sometimes it says export interface myState and others export interface IProps. The naming is kind of confusing

  • Visual error:

Suggested improvements to the Smart Items documentation

https://docs.decentraland.org/development-guide/smart-items/

  1. There is a misworded sentence,
    It currently reads:
    "When new players join the scene, the make sure that they obtain any relevant information from other players about the current state of the item. To do this, the door item sends out a channel.request when spawning, and if there are any other players with instances of that door they will reply with a boolean indicating if the door is currently open."

It should probably read:
"When new players join the scene, make sure that they obtain any relevant information from other players about the current state of the item. For example, to do this, the door item should out a channel.request when spawning, and if there are any other players with instances of that door there should be code that will reply with a boolean indicating if the door is currently open."

  1. The general item data listed for the manifest has the keywords capitalized, like "Name", should be lowercase, like "name".

  2. The manifest documentation fails to mention what to do with the initial id field. I assume one should give it a unique UUID, which can be obtained from an online UUID V4 generator.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    šŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. šŸ“ŠšŸ“ˆšŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ā¤ļø Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.