PixelPlanetApi 1.0.3

A simple library to interact with pixelplanet.fun API

Install-Package PixelPlanetApi -Version 1.0.3
dotnet add package PixelPlanetApi --version 1.0.3
<PackageReference Include="PixelPlanetApi" Version="1.0.3" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add PixelPlanetApi --version 1.0.3
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

PixelPlanetApi

A simple library to interact with pixelplanet.fun API

Installation

Install as regular NuGet package:

Install-Package PixelPlanetApi

Usage

  1. Create a PixelPlanetClient instance

    PixelPlanetClient client = await PixelPlanetClient.Create();
    

    You can pass HttpClient handler configuration as argument. This allows you to use proxy, cookies etc.

    PixelPlanetClient _client = await PixelPlanetClient.Create(h =>
    {
        h.CookieContainer = new CookieContainer();
        h.CookieContainer.Add(new Cookie
        {
            Name = "pixelplanet.session",
            Value = "session",
            Domain = "pixelplanet.fun",
            Path = "/",
        });
    });
    
  2. Use client methods to interact with pixelplanet.fun

Quick examples

  • Place pixel

    Pixel pixel = new Pixel
    {
        X = 10000,
        Y = 5000,
        Color = 3
    };
    PixelReturn response = await _client.PlacePixel(0, pixel).ConfigureAwait(false);
    if (response.ReturnCode == ReturnCode.Success)
    {
      // ...
    }
    
  • Register area for tracking and subscribe to PixelChangeEvent to receive updates

    Area area = new Area
    {
        X1 = 8000,
        Y1 = 4000,
        X2 = 15000,
        Y2 = 6000,
        CanvasId = 0
    };
    client.TrackArea(area);
    client.PixelChangeEvent += (sender, args) => 
    {
      // ...
    };
    
  • Get chunk data

    byte[] data = await client.GetChunkData(11, 22, 0);
    
  • Get user statistics

    MeResponse me = await _client.FetchMe();
    
  • Pay attention to Canvas type. It has a lot of useful methods to work with canvas data.

    Canvas canvas = _client.Canvases[0]; // Earth canvas
    (byte cx, byte cy) = canvas.GetChunkOfPixel(1000, 1500); // Chunk coordinates for the pixel
    int offset = GetOffsetOfPixel(2222, 800); // Offset is the count of pixels from the start of chunk.
    short x = GetAbsoluteCoordinate(10, 200);
    HashSet<(byte, byte)> areaChunks = canvas.GetChunksForArea(area);
    
  • See other PixelPlanetClient public methods. I will try to make more convenient documentation soon

PixelPlanetApi

A simple library to interact with pixelplanet.fun API

Installation

Install as regular NuGet package:

Install-Package PixelPlanetApi

Usage

  1. Create a PixelPlanetClient instance

    PixelPlanetClient client = await PixelPlanetClient.Create();
    

    You can pass HttpClient handler configuration as argument. This allows you to use proxy, cookies etc.

    PixelPlanetClient _client = await PixelPlanetClient.Create(h =>
    {
        h.CookieContainer = new CookieContainer();
        h.CookieContainer.Add(new Cookie
        {
            Name = "pixelplanet.session",
            Value = "session",
            Domain = "pixelplanet.fun",
            Path = "/",
        });
    });
    
  2. Use client methods to interact with pixelplanet.fun

Quick examples

  • Place pixel

    Pixel pixel = new Pixel
    {
        X = 10000,
        Y = 5000,
        Color = 3
    };
    PixelReturn response = await _client.PlacePixel(0, pixel).ConfigureAwait(false);
    if (response.ReturnCode == ReturnCode.Success)
    {
      // ...
    }
    
  • Register area for tracking and subscribe to PixelChangeEvent to receive updates

    Area area = new Area
    {
        X1 = 8000,
        Y1 = 4000,
        X2 = 15000,
        Y2 = 6000,
        CanvasId = 0
    };
    client.TrackArea(area);
    client.PixelChangeEvent += (sender, args) => 
    {
      // ...
    };
    
  • Get chunk data

    byte[] data = await client.GetChunkData(11, 22, 0);
    
  • Get user statistics

    MeResponse me = await _client.FetchMe();
    
  • Pay attention to Canvas type. It has a lot of useful methods to work with canvas data.

    Canvas canvas = _client.Canvases[0]; // Earth canvas
    (byte cx, byte cy) = canvas.GetChunkOfPixel(1000, 1500); // Chunk coordinates for the pixel
    int offset = GetOffsetOfPixel(2222, 800); // Offset is the count of pixels from the start of chunk.
    short x = GetAbsoluteCoordinate(10, 200);
    HashSet<(byte, byte)> areaChunks = canvas.GetChunksForArea(area);
    
  • See other PixelPlanetClient public methods. I will try to make more convenient documentation soon

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version History

Version Downloads Last updated
1.0.3 179 6/9/2020
1.0.1 132 6/5/2020
1.0.0 107 6/4/2020